mordor

Backend server for Gondor.

Setup

To setup the project run:

npm install

Compile TS

To compile the code:

npm run build // compile once

or

npm run watch // watch files and recompile whenever they change

The compiled js code can be found in dist/bundle.js.

Run the server

To run the server:

npm run node // run the server

or

npm run nodemon // watch files and restart the server whenver they change

Documentation

To generate the documentation:

npm run docs

Environment variables

An .env file can be used to specify environment variables. See sample file.

Please note: the configured database must exist.

Conventions and guidelines

Versioning

https://semver.org/

Commits

https://www.conventionalcommits.org/