The Charity Backend

Prerequisites

• git >= 2
• volta >= 1

Setup

After you've made sure to have the correct things (and versions) installed just run:

npm install

Also, you should fill in the environment variables, you can copy the variables from example.env using the below command:

cp example.env .development.env

then you need to migrate your database and keep it synced with schema using the below command:

npm run migrate

and the final step is to run the seed script to fill your local database, for example creating an admin record:

npm run seed

Scripts

Run

to run the app in the development environment just run:

npm run dev

Run in debug mode

npm run debug

Build

To build the app just run:

npm run build

Lint

To run the linter to auto-fix all the problems run:

npm run lint

Test

To run the unit tests run:

npm run test

Run test and debug

npm run test:debug

Run tests and watch

npm run test:watch

Add migration or apply it on development environment

npm run migrate

Find Spelling Errors

To find spelling errors just run

npm run spell

If you wanted to add a new word so that it won't count as spelling error, just add it to the configs/cspell/dictionary.txt and separate with a new line

General Notes

• if you are using vscode you can use Prisma extension for autocomplete on schema.prisma file
• if you are using vscode you can use Code Spell Checker extension to check spelling error without running cspell script