exarus/training-nestjs

TODO App with NestJS, Prisma, and MySQL

This project is a simple TODO application built with NestJS, Prisma, and MySQL. It includes basic authentication and a TODO management system.

Task for Candidates

You are tasked with reviewing, improving, and fixing this codebase. This application intentionally contains poor practices, missing features, and bugs. Your goal is to refactor and enhance the project while following modern backend development best practices.

---

Requirements

Your submission must include the following:

1. Code Improvements

• Refactor the codebase to follow clean architecture and modular design principles.
• Ensure proper error handling (e.g., try-catch blocks, meaningful HTTP response codes).
• Implement middleware for authentication and JWT validation.
• Use DTOs and validation pipes for incoming requests.
• Avoid hardcoded values (e.g., .env for sensitive information).
• Improve database queries to handle edge cases and optimize performance.
• Add meaningful comments where necessary.

2. Unit and Integration Tests

• Write unit tests for critical services (e.g., authentication, TODO management).
• Write at least one integration test to validate the API behavior end-to-end.

3. Documentation

• Create documentation for the APIs using Postman and put the exported collection as json in the documentation/api folder.
• Provide instructions for setting up and running the project locally.

4. Edge Cases

• Handle edge cases such as invalid user input, empty TODO lists, invalid authentication tokens, etc.

---

Getting Started

Prerequisites

Ensure you have the following tools installed:

• Node.js (v16 or higher)
• MySQL (local instance or Docker)
• npm
• Git

Installation

1. Clone the repository:

git clone https://github.com/rafayeljamalyandev/Interview-ToDo-App.git

2. Install dependencies:

npm install

3. Set up the .env file:

DATABASE_URL="mysql://root:password@localhost:3306/todoapp"
JWT_SECRET="some_secret_key"

4. Apply Prisma migrations:

npx prisma migrate dev

5. Start the application:

npm run start:dev

Submission Format

1. Create a Fork • Fork this repository to your personal GitHub account.
2. Create a Feature Branch • Create a new branch for your work:

git checkout -b candidate-improvements

3. Make Changes • Commit your improvements and push them to your branch.
4. Open a Merge Request (MR) • Submit a pull request (PR) from your feature branch to the main branch of this repository.
5. Provide a Summary • In your MR description, include: • A brief overview of the changes. • Key improvements and fixes. • Instructions for testing your changes.

Evaluation Criteria

Your submission will be evaluated based on the following:

1. Code quality and readability.
2. Adherence to best practices.
3. Error handling and edge case management.
4. Test coverage and quality of tests.
5. Proper use of Prisma and database handling.
6. Documentation and clarity of instructions.

Tips • Focus on making the code modular and maintainable. • Write meaningful commit messages. • Don’t overcomplicate — aim for clarity and maintainability.

Good luck! 🚀

Let me know if you need further customization for the README.md file or assistance!