- Install Node.js and npm. Versions must match the
package.json
fieldengines
requirements. - Duplicate
.env.example
as.env
and configure the environment variables. - In the project directory, run
npm install
(see Install script).
For development, in a terminal in the project directory run npm run dev
(see Dev script).
Your editor must support:
- EditorConfig
- Prettier (formatting on save is highly recommended)
- ESLint
- TypeScript
These CLI scripts are used to install, build, serve, and quality check the project.
To install dependencies:
npm install
To build the .next
directory and serve the app, watching source files for changes to automatically rebuild and serve:
npm run dev
To build the .next
directory:
npm run build
Beforehand, run the build script (see Build script).
To serve the app:
npm run serve
To run all quality checks:
npm run check
To check formatting with Prettier:
npm run prettier
To lint with ESLint:
npm run eslint
To type check with TypeScript:
npm run type-check
To find unused exports with find-unused-exports
:
npm run find-unused-exports