gftf2011/clean-node-todolist

Node.Js API built with Clean Architecture and Design Patterns that runs in REST and Graphql at the same time

CLEAN Node.JS TODOLIST • 📒 💻

About • Supported OS • Design Patterns • Principles • Business Rules • Required Tools • Running Project • Running Tests • License

📄 About

This a backend from a TODO LIST typescript project.

The objective from this project is to show how to create an API with a well-defined and decoupled architecture, using Clean Architecture concepts, dividing the layers responsibility and exploring the usage of several design patterns !

🛠️ Supported OS

• Mac OS
• Linux
• Windows - WSL

🔷 Design Patterns

Creational

• Abstract Factory
• Factory Method
• Builder
• Singleton

Structural

• Adapter
• Composite
• Decorator
• Proxy

Behavioral

• Chain of responsability
• Command
• Mediator
• Strategy
• Template method

Non GOF - Gang of Four - Official

• Monad Either

📘 Principles

• Single Responsibility Principle (SRP)
• Open Closed Principle (OCP)
• Liskov Substitution Principle (LSP)
• Interface Segregation Principle (ISP)
• Dependency Inversion Principle (DIP)
• Separation of Concerns (SOC)
• Don't Repeat Yourself (DRY)
• You Aren't Gonna Need It (YAGNI)
• Keep It Simple, Stupid (KISS)
• Composition Over Inheritance

🏗️ Business Rules

• Sign-Up
• Sign-In
• Find Note
• Find Note By User ID
• Create Note
• Update Note
• Update Note Finishing Status
• Delete Note

📋 Required Tools

• Node - https://nodejs.org/
  • Node version: 18.x.x
  • npm version: 9.x.x
• Docker - https://www.docker.com/

🏎️ Running Project

  $ npm i
  $ npm run start:dev

OBS.: Ensure to install all dependencies in Required Tools

🧪 Running Tests

Unit Tests

  $ npm run test:unit

Integration Tests

  $ npm run test:integration

E2E Tests

  $ npm run test:e2e

Full Test Coverage Report

  $ npm run test

📝 License

This project is under MIT license. See the LICENSE file for more details.

---

Made with lots of ❤️ by Gabriel Ferrari Tarallo Ferraz