commands.md

Common commands

Installing Dependencies

Run the following command to install dependencies

npm install

Running the Project and the Database

Run the following to start the project and run the dev database

docker-compose -f docker-compose.dev.yml up -d

Open http://localhost:3000 with your browser to see the result.

Apply latest database migrations

npx prisma db push

Linting the Project

Run the following to lint and format the project

npm run lint
# Or
next lint

Add --fix to automatically fix linting problems

Testing the Project

Run the following to open Cypress

npm run cypress:open

Development environment variable

Please view in private channel #dotenv

Database migration

If you make changes to prisma models, you can migrate the database by

npx prisma migrate dev --name <migration-name>

Note: migration-name should be a short description of the changes you made

Database exploration

You can view your tables, columns, and make changes to your local database by

npm run prisma:explore

Database UML diagram

Generate a png image of the latest database UML diagram via the database schema by

prisma-uml ./prisma/schema.prisma -o png -f ./docs/design/databaseUML.png

Note: file will be added to ./docs/design directory