/
Developer Quickstart

Developer Quickstart

Developer Quickstart

Verified against dev-next. Prefer repository scripts and CI setup if this page and the README diverge.

What you need

  • Rocky Linux 9 or RHEL 9 environment, or an existing NMS Prime install to overlay with git

  • PHP 8.3, Composer, Node.js, npm

  • PostgreSQL for the primary application database

  • Access to the NMS Prime source repository

Recommended setup path

Operator or full-stack base install

Install the Rocky 9 / RHEL 9 stack and NMS Prime packages first so system dependencies are present. Public install guidance lives under Installation.

Developer git overlay

After the package-based dependencies are present, replace the installed application tree with a git checkout under /var/www/nmsprime. The README developer section and scripts/install-from-git.sh document the current bootstrap path used by CI.

Typical post-checkout commands

cd /var/www/nmsprime composer install npm install php artisan migrate php artisan module:migrate --all php artisan module:publish --all npm run dev php artisan optimize

Do not rely on older wiki or README mentions of php artisan module:v6:migrate as the current primary path. Prefer module:migrate --all as used by install and upgrade hooks.

Configuration model

  • Runtime configuration lives in /etc/nmsprime/env/*.env

  • Do not hardcode site-specific values into config/*.php for an installation

  • Frontend Mix builds expect ENV_FILE=/etc/nmsprime/env/global.env

  • Admin UI commonly runs on port 8080

Day-to-day commands

Task

Command

Task

Command

Run tests

php artisan test

Prepare / repair local test databases

php artisan test:setup-databases

Format changed PHP

./vendor/bin/pint --dirty

Build frontend assets

npm run dev or npm run prod

List modules

php artisan module:list

Where to go next