shahanahmed86 / miletap-nodejs

@shahanahmed86/miletap-nodejs

Prerequisites

• Resources

  • Docker Desktop
  • NODE or NVM
  • Make

  • Knowledge

  • JavaScript
  • Restful
  • Docker architecture
  • Container orchestration with docker compose (at-least)
  • node:18 and its npm installer
  • swagger

Implemented Feature

• User/Admin authentication APIs
• Users query for admin APIs
• Email will be send to the admin when a user signs up
• Pre-commit hook to check linting and formatting
• Pre-push hook to check test coverage
• Used JWT for authentication instead of firebase or oauth
• Chai & Mocha used to cover api testing
• api documents are exposed on /api-docs

Installation steps

cp .env.example .env # Please read the comments carefully

npm run up # to create containers for postgres and adminer
npm run down # to remove containers
npm run down:hard # to remove containers and clean their data also

# database migrations
npm run migrate:up # to run migrations (create tables and run seeds)
npm run migrate:down # it will only undo the last run migration

# test
# make sure to run `npm run up` and npm run migrate:up
npm test

# finally
npm run start:dev # to run dev environment