OpenParable
Skip to content
← Back to skills

About Netalertx Project Structure

Development
about-netalertx-project-structure

About Netalertx Project Structure is an Agent Skill for development published in the netalertx/NetAlertX repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Navigate the NetAlertX codebase structure. Use this when asked about file locations, project structure, where to find code, or key paths.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/netalertx/NetAlertX/blob/HEAD/.github/skills/project-navigation/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/about-netalertx-project-structure, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Project Navigation

Key Paths

ComponentPath
Workspace root/workspaces/NetAlertX
Backend entryserver/__main__.py
API serverserver/api_server/api_server_start.py
Plugin systemserver/plugin.py
Initializationserver/initialise.py
Frontendfront/
Frontend JSfront/js/common.js
Frontend PHPfront/php/server/*.php
Pluginsfront/plugins/
Plugin templatefront/plugins/__template
Database helpersserver/db/db_helper.py
Device modelserver/models/device_instance.py
Messagingserver/messaging/
Workflowsserver/workflows/

Architecture

NetAlertX uses a frontend–backend architecture: the frontend runs on PHP + Nginx (see front/), the backend is implemented in Python (see server/), and scheduled tasks are managed by a supercronic scheduler that runs periodic jobs.

Runtime Paths

DataPath
Config (runtime)/data/config/app.conf
Config (default)back/app.conf
Database/data/db/app.db
API JSON cache/tmp/api/*.json
Logs/tmp/log/
Plugin logs/tmp/log/plugins/

Environment Variables

Use these NETALERTX_* instead of hardcoding paths. Examples:

  • NETALERTX_DB
  • NETALERTX_LOG
  • NETALERTX_CONFIG
  • NETALERTX_DATA
  • NETALERTX_APP

Documentation

TopicPath
Plugin developmentdocs/PLUGINS_DEV.md
System settingsdocs/SETTINGS_SYSTEM.md
API docsdocs/API_*.md
Debug guidesdocs/DEBUG_*.md