1. Create a .env file following the template in .env.example. Replacing any of the example values where appropriate. e.g.:

AWS_ACCESS_KEY_ID = AKIAIOSFODNN7EXAMPLE
AWS_SECRET_ACCESS_KEY = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
AWS_REGION = us-east-1

2. Run docker compose, starting up a local DynamoDB image with an in-memory database. (This step requires a local docker installation)

docker compose up

3. Install dependencies.

npm install

4. Run server in development mode.

npm run dev

1. Complete the first 3 steps in the section above.

2. Run either of the following test scripts:

npm run test

npm run test:watch

npm run test:coverage

The API specification can be consulted by accessing the URL below while running the project locally.

https://localhost:$PORT/api/docs