CLEAN React.JS TODOLIST • 📒 💻

About • Supported OS • Technologies • Concepts • Design Patterns • Principles • Required Tools • Running Project • Running Tests • License

📄 About

This a frontend from a TODO LIST typescript project.

The objective from this project is to show how to create an WEB APP 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

🤖 Technologies

• React.JS
• React Router Dom
• React Redux
• React Testing Library
• Vite
• Vitest
• Eslint
• Prettier
• Github Action

🔶 Concepts

• Advanced Object Oriented Programming
• Functional Programming
• Redux
• Clean Code
• Clean Architecture
• Design Patterns - (Object Oriented)
• Design Patterns - (Functional Style)
• Unit Testing
• Integration Testing
• Continuous Integration Pipeline
• Semantic Commits
• Test Doubles - (Dummies • Stubs • Spies • Fakes • Mocks)
• Linting
• Browser Cache
• Cache Validation

🔷 Design Patterns

Creational

• Builder
• Singleton

Structural

• Facade
• Adapter
• Composite
• Decorator
• Proxy

Behavioral

• Visitor
• Template method

Non GOF - Gang of Four - Official

• Dinamic Factory

📘 Principles

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

📋 Required Tools

• Node - https://nodejs.org/
  • Node version: 18.x.x
  • npm version: 9.x.x

🏎️ Running Project

  $ npm i

  $ npm run dev

  $ npm run dev:server

OBS.: Use 2 Terminals, one to run the development server first and the second to run the application

🧪 Running Tests

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