shahanahmed86 / candidates-registry

@shahanahmed86/candidate-registry

Prerequisites

• Resources

  • Docker Desktop
  • FastAPI
  • Make

  • Knowledge

  • Python
  • Restful
  • Docker architecture
  • Container orchestration with docker compose (at-least)
  • fastapi and the poetry as the package manager
  • swagger for api documentation

Implemented Feature

• api documents are exposed on /docs
• User authentication APIs
• Candidates CRUD operations
• Pre-commit hook to check linting and formatting
• Used JWT for authentication

Installation steps

cp .env.example .env # Please read the comments carefully
cp .env.example .env.dev # for development

# to create containers for mongodb, mongo-express, nginx along-with server
# and this will also expose the server to `http://localhost`
make run-container-up
make run-container-down # to remove containers
make run-container-down-hard # to remove containers and clean their data also