feat(todos): implement protected CRUD for user-specific todos

Author: mohammadhasanii

.env.example

@@ -2,5 +2,5 @@ DATABASE_URL="mongodb://localhost:27017/db"
 PORT=3000
 HOST="localhost"
 SWAGGER_ROOT="/docs"
-JWT_SECRET="YOUR_SUPER_SECRET_KEY"
+JWT_SECRET="YOUR_SUPER_SECRET_KEY" # Replace with your actual secret key
 JWT_EXPIRES_IN="1h"

Dockerfile

@@ -0,0 +1,8 @@
+FROM node:18-alpine
+WORKDIR /app
+COPY --from=builder /app/package*.json ./
+RUN npm install --only=production
+COPY --from=builder /app/dist ./dist
+COPY --from=builder /app/prisma ./prisma
+EXPOSE 3000
+CMD ["node", "dist/main"]

README.md

@@ -1,98 +1,79 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
-</p>
-
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
-
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
-<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
-<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
-    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
-
-## Description
-
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
-
-## Project setup
+# NestJS Todo API
 
-```bash
-$ npm install
-```
+A RESTful API for a simple todo list manager, built with NestJS, TypeScript, and Prisma. This project serves as a demonstration of modern backend development practices, including JWT authentication, robust validation, and a clean, modular architecture.
 
-## Compile and run the project
+![Alt Text](nest.png)
 
-```bash
-# development
-$ npm run start
+---
 
-# watch mode
-$ npm run start:dev
+## Features
 
-# production mode
-$ npm run start:prod
-```
+-   **JWT-based Authentication**: Secure user registration and login endpoints.
+-   **Protected Routes**: All todo-related endpoints require a valid access token.
+-   **Full CRUD Functionality**: Create, Read, Update, and Delete operations for user-specific todos.
+-   **Validation**: DTO-based validation for all incoming request bodies using `class-validator`.
+-   **API Documentation**: Auto-generated and detailed API documentation with Swagger.
 
-## Run tests
+---
 
-```bash
-# unit tests
-$ npm run test
+## Tech Stack
 
-# e2e tests
-$ npm run test:e2e
+-   **Framework**: [NestJS](https://nestjs.com/)
+-   **Language**: [TypeScript](https://www.typescriptlang.org/)
+-   **ORM**: [Prisma](https://www.prisma.io/)
+-   **Database**: [MongoDB](https://www.mongodb.com/)
+-   **Authentication**: [JWT](https://jwt.io/) with [Passport.js](http://www.passportjs.org/)
+-   **Validation**: [class-validator](https://github.com/typestack/class-validator) & [class-transformer](https://github.com/typestack/class-transformer)
 
-# test coverage
-$ npm run test:cov
-```
+---
 
-## Deployment
+## Getting Started
 
-When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
+Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
 
-If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
+### Prerequisites
 
-```bash
-$ npm install -g @nestjs/mau
-$ mau deploy
-```
+-   [Node.js](https://nodejs.org/en/) (v18 or later recommended)
+-   [npm](https://www.npmjs.com/)
+-   A running [MongoDB](https://www.mongodb.com/try/download/community) instance (must be running as a replica set for Prisma transactions).
 
-With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
+### Installation & Setup
 
-## Resources
+1.  **Clone the repository:**
+    ```bash
+    git clone https://github.com/mohammadhasanii/NestTodo-API.git
+    ```
 
-Check out a few resources that may come in handy when working with NestJS:
+2.  **Navigate to the project directory:**
+    ```bash
+    cd NestTodo-API
+    ```
 
-- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
-- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
-- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
-- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
-- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
-- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
-- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
-- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
+3.  **Install dependencies:**
+    ```bash
+    npm install
+    ```
 
-## Support
+4.  **Configure environment variables:**
+    Create a `.env` file in the root of the project by copying the example file:
+    ```bash
+    cp .env.example .env
+    ```
+    Then, update the `.env` file with your specific configuration.
 
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+    ```env
+    # The connection string for your MongoDB instance.
+    # Note: ?replicaSet=rs0 is required if your MongoDB is running as a replica set.
+    DATABASE_URL="mongodb://localhost:27017/db?replicaSet=rs0"
 
-## Stay in touch
+    # A strong, secret key for signing JWTs
+    JWT_SECRET="YOUR_SUPER_SECRET_KEY"
+    JWT_EXPIRES_IN="1h"
+    ```
 
-- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
+### Running the Application
 
-## License
+To run the application in development mode with hot-reloading:
 
-Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
+```bash
+npm run start:dev

nest.png

@@ -4,11 +4,14 @@
     "type": "git",
     "url": "https://github.com/mohammadhasanii/NestTodo-API.git"
   },
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "",
   "author": "",
   "private": true,
   "license": "UNLICENSED",
+  "prisma": {
+    "seed": "ts-node prisma/seed.ts"
+  },
   "scripts": {
     "build": "nest build",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
@@ -28,12 +31,15 @@
     "@nestjs/config": "^4.0.2",
     "@nestjs/core": "^11.0.1",
     "@nestjs/jwt": "^11.0.0",
+    "@nestjs/passport": "^11.0.5",
     "@nestjs/platform-express": "^11.0.1",
     "@nestjs/swagger": "^11.2.0",
     "@prisma/client": "^6.12.0",
     "bcrypt": "^6.0.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.2",
+    "passport": "^0.7.0",
+    "passport-jwt": "^4.0.1",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1"
   },
@@ -49,6 +55,7 @@
     "@types/express": "^5.0.0",
     "@types/jest": "^29.5.14",
     "@types/node": "^22.10.7",
+    "@types/passport-jwt": "^4.0.1",
     "@types/supertest": "^6.0.2",
     "eslint": "^9.18.0",
     "eslint-config-prettier": "^10.0.1",
@@ -82,4 +89,4 @@
     "coverageDirectory": "../coverage",
     "testEnvironment": "node"
   }
-}
+}