2. Getting Started & Configuration
This section provides comprehensive step-by-step instructions for initial setup.
Prerequisite Checks
- Verified Node.js v18+ installation.
- Ensure Docker engine is active for optional production container deployments.
- Accessible PostgreSQL database for production usage OR SQLite configured for local usage.
Installation Sequence
- Clone the repository and install dependencies locally.
- Initialize environment configurations (
.env) via copying.env.example. - Start the application servers matching your target environment (
npm run dev:web).
Workflow Example: First-Time User Registration
- Context: A new security engineer needs platform access.
- Action: Direct the user to the
/registerportal or utilize Single Sign-on (Google OAuth). - Outcome: User profile is created with standard 'USER' privileges. Administrator can later upgrade permissions via
/admin/usersinterface.