To-Do List API with NodeJs + Express + PostgreSQL

First of all, what is a To-Do List? It is a list of all the tasks that you need to complete. In summary, it lists all the things you need to do, ordered by priority.

At first glance, this project may appear similar to any other to-do list project, but it's not. This API aims to put into practice a variety of backend development concepts necessary to build a robust backend project.

What concepts will you find in this project?

1. Layered pattern (repository, service, controller);
2. Unit and integration tests;
3. Database containerization;
4. Clean Code principles;
5. SOLID principles like single responsibility and dependency injection;
6. Caching;

1. Project Information

Show info

• Node version: 18.16.0
• Framework: Express
• Database: PostgreSQL + Redis (cache)
• ORM: Sequelize
• Design Pattern: Layered Architecture + Composition Root
• Authentication: Json Web Token
• Validation: Joi
• Tests: Jest
• Logs: Winston

2. Locally Project Setup

Show info

• Create a .env file following the .env.example structure and fill all information about server, database, security and log configurations.

# Server configurations
PORT=

# Database configurations
DB_HOST_DEV=
DB_PORT_DEV=
DB_USER_DEV=
DB_PASSWORD_DEV=
DB_NAME_DEV=

DB_HOST_TEST=
DB_PORT_TEST=
DB_USER_TEST=
DB_PASSWORD_TEST=
DB_NAME_TEST=

# Jwt configurations
SECRET_KEY=

# Log configuration
LOG_LEVEL=

• Install all the required packages using the following command npm install. And start the project with the following scripts.

- Scripts:

1. This script will start the project with the production environment:

npm run start

2. The following script will start the project with the development environment, starting postgresql and redis containers:

npm run start:dev

3. The next script will run the unit tests, starting postgresql and redis containers with the test databases:

npm run test:unit

4. The last script will run the integration tests, starting postgresql and redis containers with the test databases:

npm run test:int

3. Project Structure

Show info

• The project follows a layered pattern, with a hierarchical structure that includes a repository layer as a dependency for the service layer, which in turn serves as a dependency for the controller layer.

• The main classes of the project are crafted using abstract classes, all of which are interconnected in a composition root layer. This thoughtful design ensures a clear and maintainable architecture, promoting modularity and ease of future development.

• Database

• This API revolves around two primary entities: 'user' and 'task.' These entities are interconnected through a one-to-many relationship. In this relationship, a single user can be associated with multiple tasks, while each task is uniquely linked to only one user.

• The management of cached data is governed by flags within the system. When modifications are made to the database, the 'stale' flag is promptly set to true. This signals the method responsible for loading all tasks to initiate a data refresh. Simultaneously, the 'refreshing' flag is also activated, indicating that the data renewal process is underway. As an illustration, consider the scenario where a task is deleted, triggering the setting of the 'stale' flag to true. This systematic approach ensures that the system efficiently handles data updates, maintaining accuracy and responsiveness.

• Within the findAll method of the TaskService, the system checks the isStale flag. It assesses whether another request is currently in the process of refreshing the data. If the stale flag is true and no other request is actively refreshing the data, the list of tasks undergoes a renewal process. This mechanism ensures that the data remains up-to-date and is refreshed only when necessary, optimizing the efficiency of the TaskService functionality.

4. Endpoints

Show info

• This API provides comprehensive CRUD operations for managing both user details and tasks seamlessly. Additionally, it offers an authentication route that generates a token, facilitating access to other protected routes. This robust feature set empowers users to efficiently handle user information and task management while ensuring secure access to protected resources.

• Explore the details of all available endpoints by navigating to the following route. The documentation, crafted using the Swagger tool and adhering to the OpenAPI specification, offers a comprehensive guide to the API's structure and functionalities. This resource serves as a valuable reference for developers seeking a clear understanding of the API's capabilities and usage.

http://localhost:PORT/api-docs/

5. How to contribute?

Show info

1. Fork this repository

2. Clone the repository

Open a terminal and run the following git command:

git clone "url you just copied"

3. Create a branch

git checkout -b your-new-branch-name

4. Make necessary changes and commit those changes

Add those changes to the branch you just created using the following command:

git add .

Now commit those changes using following command:

git commit -m "Briefly describe the changes made"

5. Push changes to GitHub

Push your changes using the following command:

git push -u origin your-branch-name

6. Submit your changes for review on GitHub

Contact Information:

• Questions and feedbacks are very welcome.

• Email: lukas.veiga10@gmail.com