about-netalertx-project-structure
A navigation guide for the NetAlertX codebase, including directory paths and component roles.
Install
mkdir -p .claude/skills/about-netalertx-project-structure && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/2648" && unzip -o skill.zip -d .claude/skills/about-netalertx-project-structure && rm skill.zipInstalls to .claude/skills/about-netalertx-project-structure
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Navigate the NetAlertX codebase structure. Use this when asked about file locations, project structure, where to find code, or key paths.Key capabilities
- →Locate backend source code
- →Identify frontend and plugin directories
- →Map architecture components to paths
- →Reference runtime configuration locations
How it works
It maps the NetAlertX project architecture to specific file paths, distinguishing between Python backend components, PHP frontend files, and runtime data directories.
Inputs & outputs
When to use about-netalertx-project-structure
- →Locate backend source code
- →Find configuration and database paths
- →Identify frontend/plugin directories
- →Understand project architecture
About this skill
Project Navigation
Key Paths
| Component | Path |
|---|---|
| Workspace root | /workspaces/NetAlertX |
| Backend entry | server/__main__.py |
| API server | server/api_server/api_server_start.py |
| Plugin system | server/plugin.py |
| Initialization | server/initialise.py |
| Frontend | front/ |
| Frontend JS | front/js/common.js |
| Frontend PHP | front/php/server/*.php |
| Plugins | server/plugins/ |
| Plugin template | server/plugins/__template |
| Database helpers | server/db/db_helper.py |
| Device model | server/models/device_instance.py |
| Messaging | server/messaging/ |
| Workflows | server/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
| Data | Path |
|---|---|
| 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_DBNETALERTX_LOGNETALERTX_CONFIGNETALERTX_DATANETALERTX_APP
Documentation
| Topic | Path |
|---|---|
| Plugin development | docs/PLUGINS_DEV.md |
| System settings | docs/SETTINGS_SYSTEM.md |
| API docs | docs/API_*.md |
| Debug guides | docs/DEBUG_*.md |
When not to use it
- →When searching for external library documentation
Limitations
- →Does not contain live file system contents
How it compares
This provides a direct mapping of the specific NetAlertX repository layout rather than relying on generic project structure conventions.
Compared to similar skills
about-netalertx-project-structure side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| about-netalertx-project-structure (this skill) | 2 | 6mo | No flags | Beginner |
| mcp-builder | 136 | 3mo | Review | Advanced |
| architecture-patterns | 55 | 2mo | No flags | Advanced |
| deepwiki-rs | 25 | 9mo | Review | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by netalertx
View all by netalertx →You might also like
mcp-builder
anthropics
Guide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).
architecture-patterns
wshobson
Implement proven backend architecture patterns including Clean Architecture, Hexagonal Architecture, and Domain-Driven Design. Use when architecting complex backend systems or refactoring existing applications for better maintainability.
deepwiki-rs
sopaco
AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation. Use when Claude needs to analyze source code, understand software architecture, generate technical specs, or create professional documentation from any programming language.
langchain-architecture
wshobson
Design LLM applications using the LangChain framework with agents, memory, and tool integration patterns. Use when building LangChain applications, implementing AI agents, or creating complex LLM workflows.
python-design-patterns
wshobson
Python design patterns including KISS, Separation of Concerns, Single Responsibility, and composition over inheritance. Use when making architecture decisions, refactoring code structure, or evaluating when abstractions are appropriate.
python-project-structure
wshobson
Python project organization, module architecture, and public API design. Use when setting up new projects, organizing modules, defining public interfaces with __all__, or planning directory layouts.