Readme Boilerplate

README.md

Getting started

Running Locally

Note: Make sure you have the node and npm versions listed in package.json

1. Install dependencies: npm install
2. Start a dev server server: npm run dev (watches for changes and restarts automatically )
3. ...or start a production server: npm start

When running locally, you can use a .env file.

See the sample.env file for all required environment variables.

Running in Docker Dev Mode

Note: Make sure you have docker installed

1. Run npm install

2. Run npm run docker:dev

Running in Docker Production Mode

Note: Make sure you have docker installed

1. Run npm install

2. Run npm run docker

Testing

This project has a Jest test suite.

To run tests: npm test

Linting

This project uses ESLint and Prettier for code formatting.

To run linters: npm run lint or npm run lint:fix to fix errors automatically

Husky and lint-staged will enforce lint on commits.