This project requires Docker Compose to develop and test. The Yarn package manager is also required, and is used instead of npm.
- Clone repository
- Override any applicable development environment variables (see Environment Variables below)
- In the project root, run
yarn start - The server is now accessible on
localhost:3000(or whatever port you configure)
You can load an interactive terminal for the app container via yarn terminal. This will allow you to add, remove, or upgrade project dependencies using Yarn (among other things). Note: the application instance must be running via yarn start for the terminal to load.
Production environment variables are not under version control, per Part 3 of the 12 Factors. As such, the dotenv package is used to manage your variables locally.
- Create a
.envfile in the project root (at the same level as thepackage.jsonfile) - Set (or change) values for the following variables:
APP_PORT=3000
DEBUG=express:*