- Clone the repository and navigate to the project directory.
- Perform
npm install
at command line. - Create an empty postgres database.
- Define the environment variables in a
.env
file like below (please refer to .sample.env):
POSTGRESQL_DB_NAME=<database name to connect to>
DB_USER=<username to be used for database>
DB_PASS=<password to be used for database>
DB_HOST=<hostname to connect to for database>
- Run the command
npm run start
to run migrations, seed the database and start the server in development mode. This startsnodemon
, which restarts the server for any changes in the source files.