@nauticalliance/create
v0.1.2
Published
Scaffold Nautic Alliance projects
Readme
@nauticalliance/create
CLI scaffolding tool for Nautic Alliance projects.
Usage
npm create @nauticalliance dashboard [project-name] [flags]npm create @nauticalliance is the recommended shorthand — npm automatically resolves it to this package. You can also use npx @nauticalliance/create directly.
If project-name is omitted the CLI prompts for it interactively. The resulting folder is always named na-{project-name}.
Examples
# Minimal dashboard
npm create @nauticalliance dashboard fleet-report
# Dashboard + BigQuery
npm create @nauticalliance dashboard extras-reporting --add-bq
# Dashboard + Neon + Drizzle (default ORM)
npm create @nauticalliance dashboard owner-portal --add-neon
# Dashboard + Neon + Prisma
npm create @nauticalliance dashboard owner-portal --add-neon --prisma-orm
# Dashboard + Neon, no ORM
npm create @nauticalliance dashboard owner-portal --add-neon --no-orm
# Dashboard + Neon + BigQuery
npm create @nauticalliance dashboard owner-portal --add-neon --add-bqFlags
| Flag | Default | Description |
|---|---|---|
| --add-bq | off | Install @google-cloud/bigquery, scaffold lib/bigquery.ts, add BQ env vars |
| --add-neon | off | Install @neondatabase/serverless, scaffold Drizzle by default |
| --no-orm | off | With --add-neon: skip ORM, raw Neon client only |
| --prisma-orm | off | With --add-neon: use Prisma instead of Drizzle |
--no-orm and --prisma-orm are mutually exclusive and only valid alongside --add-neon.
Development
npm test # run unit tests
npm run test:watch # watch mode
npm run test:coveragePackage details
- Package name:
@nauticalliance/create - Entry point:
bin/index.js - Runtime: Node 22+
- Template source:
https://github.com/nauticalliance/na-dashboard-template
