project-navigation

Map key component locations in the NetAlertX codebase.

6.9k|426|Updated Dec 23, 2021
One-click install
npx skills add https://github.com/netalertx/NetAlertX --skill project-navigation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-navigation
Source: https://github.com/netalertx/NetAlertX/tree/main/.gemini/skills/project-navigation
Command: npx skills add https://github.com/netalertx/NetAlertX --skill project-navigation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps developers quickly orient themselves in the NetAlertX codebase by outlining where key components live, reducing time spent searching through directories.

Core Features & Use Cases

  • Codebase map: Lists core directories and entry points (backend, frontend, plugins, config, and database) for rapid navigation.
  • Onboarding & debugging aid: Provides a ready reference to accelerate contributor onboarding and issue investigation.
  • Use Case: A new developer needs to locate the backend entry point at server/api_server/api_server_start.py and the main configuration at /data/config/app.conf to begin debugging.

Quick Start

Locate the backend entry point, frontend directory, config, and database locations described in the Skill to orient yourself in the NetAlertX project.

Frequently Asked Questions about project-navigation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I navigate the NetAlertX codebase to find key components?

NetAlertX codebase navigation starts with identifying core entry points: the backend entry point is at server/api_server/api_server_start.py, frontend assets are in the front/ directory, plugins reside in a dedicated plugins folder, configuration lives at /data/config/app.conf, and the database is stored at /data/db/app.db. These paths form the foundation for understanding the project structure.

Where is the backend entry point in NetAlertX?

The backend entry point for NetAlertX is located at server/api_server/api_server_start.py. This file initializes the API server and is the primary starting point for backend debugging and development work.

How do I locate configuration and database files in NetAlertX?

NetAlertX stores its main application configuration at /data/config/app.conf and the database file at /data/db/app.db. These locations are essential references for understanding application settings and data storage during development and troubleshooting.

Can I use this codebase map for onboarding new developers?

Yes, the codebase map is specifically designed to accelerate contributor onboarding by providing a ready reference to backend entry points, frontend directories, plugins, configuration, and database locations, reducing time spent searching through directories.

What directories should I know about when debugging NetAlertX?

When debugging NetAlertX, focus on: server/api_server/ for backend logic, front/ for frontend assets, the plugins directory for extensions, /data/config/ for application settings, and /data/db/ for database files. This orientation supports rapid issue investigation.