Pre Requisite

• docker and docker-compose
• node.js
• nest.js cli

Feature

• Ready To Run.
• Postgres Database as Container.
• Config Service
• Read and Ensure .env variable.
• .env Sample.
• Connect Postgres Database.

Member

• Register Member.
• X-Member-Token

Todo

• Only member can create new todo with not_started status.
• Every member can list existing todo.
• Only todo owner can update their title and description.
• Only todo owner can change status.
• Only todo owner can delete todo(soft delete).
• Only todo owner can assign member.
• Send notification to all assigned member when owner delete active todo.
• Run a background scheduler to notify all assigned members.

Other

• Authorization --> UseGuards()
• Rate Limiting from header X-Forwarded-For

API Documentation

• ScaMo-todo

---

Getting Started

How to Run Project

1. Clone Project

   git clone https://github.com/pspapleng/NestJS-todo.git
   
   npm install
   

2. Run Database As Container

   docker-compose up -d
   

3. Run Project

   npm run start:dev
   

How to Run Migration

1. Generate Migration

   npm run typeorm:migration:generate -- init
   

2. Run Migration

   npm run typeorm:migration:run
   

---