FORUM API

Local Development

Prerequisites

• NodeJS version >= 14
• PostgreSQL

First Run

1. Clone repository
2. Copy .env.example to .env and adjust the values inside.
3. Install dependencies

   npm i

4. Run migration

   npm run migrate up
   npm run migrate:test up # For automation testing

5. Start development server

   npm run start:dev

Useful Scripts

• start => run production server

  pm2 start npm --name "auth-api" -- run "start"

• format => format code with standardjs style
• test => run comprehensive tests with coverage report
• test:watch => run all tests when a file has changed
• test:watch:changed => run tests related to changed files
• test:newman => run postman tests on CLI

Notes

• Endpoint: https://spicy-fireant-6.a276.dcdg.xyz/
• Repository: https://github.com/kamalmahmudi/forum-api
• Github workflows: https://github.com/kamalmahmudi/forum-api/actions
  • ❌ Failed CI: https://github.com/kamalmahmudi/forum-api/actions/runs/1666715183
  • ✔️ Success CI: https://github.com/kamalmahmudi/forum-api/actions/runs/1667189776
  • ❌ Failed CD: https://github.com/kamalmahmudi/forum-api/actions/runs/1666037340/attempts/1 (this action was executed for second time, so it's a success now)
  • ✔️ Success CD: https://github.com/kamalmahmudi/forum-api/actions/runs/1666062409