Installation

#1. Prerequisites

Check your machine any time with:

npx nestlaravel doctor

#2. Create a project

npx nestlaravel create my-project        # sqlite for the gateway (zero setup)
npx nestlaravel create my-project --db pgsql --migrate
cd my-project

create performs, in order: requirement checks → workspace scaffold → .env files with fresh random secrets (APP_KEY, database/Redis passwords) → composer install (gateway) → npm install (Nx) → optional migrations + role seeding → git init → validation (nx show projects, gateway test suite) → next steps.

Options: --db sqlite|pgsql|mysql, --with-portals, --migrate, --skip-install, --skip-git, --skip-validate, --skip-checks, -y.

Nothing is committed: .env files are git-ignored and never included in the npm package.

#3. First service and dev loop

npx nestlaravel generate service orders
npx nestlaravel dev                # infra (Docker) + all apps

• Gateway: <http://127.0.0.1:8000> — service orders: port 8001 (internal; reach it via /api/v1/orders/*).
• dev starts Postgres, Redis and Kafka with Docker Compose when Docker is running; otherwise it warns and continues with the log/null Kafka driver. --no-infra skips Docker; --docker runs the whole stack in containers (real Kafka through ext-rdkafka inside the images).

#4. Verify

npx nestlaravel test        # every app's test suite via Nx
npx nestlaravel lint        # Laravel Pint (style)
npx nestlaravel build       # production Docker images (needs Docker)

#Troubleshooting