App Template

Basic web-api template. If you need to add, for example, sockets, convention is to add source/sockets.ts along with source/sockets/. Follow existing api-logic.

Local dev deploy

Pre-requisites

• Unix-like OS (Ubuntu works properly; MacOS not tested)
• Node Version Manager
• Docker

Deploy

1. Update Node.js version
   • put the required node version into .nvmrc file
   • nvm use
2. Initiate .env file
   • cp .env.example .env
   • put proper values (PROJECT_NAME is the only value to update at the moment)
3. Update packages versions
   • make update-npm-packages
   • npm install

     If something goes wrong, read the log & manually rollback the package(s) version. Sometimes it happens for reasons beyond me (npm-check-updates package just updates the package.json)

4. Update Docker-images versions
   • docker-compose.dev.yml:
     • services/image: image
5. Run docker-compose
   • make compose-up

     -down for removing containers with their volumes; -stop & -start for pausing & starting the containers, respectively

6. Update config values
   • config/default.ts
7. Run the API in dev-mode
   • npm run api:dev

Optional

• npx husky init, if you want to use git-hooks. Links: Git Hooks, Husky

Database

• npm run migrate:make for creating new migration-file

• npm run migrate for migrating existing files

• make psql for direct PG access inside of container