The required Node.js and Yarn versions are listed in the package.json
file.
You can run nvm use
and yvm use
from the project root if you have Node version manager and Yarn version managers installed to select the correct version.
MONGO_URL
URL to a running Mongo instance which includes user and passwordBYPASS_MONGO
if set to "true"
, will drop the database on each request, to get fresh data from external APIS. Use with caution.UMS_API_PRIVATE_KEY_LOCATION
and UMS_API_PUBLIC_KEY_LOCATION
optional absolute locations of SSL keys for HTTPSyarn watch
Watches for changes to TypeScript files and compiles them to JavaScript (use yarn run build
to do it manually)
yarn dev
Runs the development server and restarts it when any file is changed
yarn dev:cron
Runs the cron job feature using ts-node
yarn start
Runs the server
yarn test
Runs the test suite
yarn run start:prod
Starts the API and cron job in production mode. TypeScript files are compiled in memory on application start.