{"id":31692395,"url":"https://github.com/gftf2011/clean-node-todolist","last_synced_at":"2026-03-04T02:32:10.965Z","repository":{"id":162766319,"uuid":"621617660","full_name":"gftf2011/clean-node-todolist","owner":"gftf2011","description":"Node.Js API built with Clean Architecture and Design Patterns that runs in REST and Graphql at the same time","archived":false,"fork":false,"pushed_at":"2024-07-19T11:55:42.000Z","size":946,"stargazers_count":17,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-08T14:13:59.396Z","etag":null,"topics":["clean-architecture","clean-code","coveralls","cqs","design-patterns","docker","docker-compose","dockerfile","github-actions","graphql","javascript","nodejs","postgresql","rest","rest-api","sonar","sonarcloud","test","typescript"],"latest_commit_sha":null,"homepage":"https://github.com/gftf2011","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gftf2011.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-31T03:05:57.000Z","updated_at":"2025-08-23T02:25:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"47a40186-10f0-4644-99e6-0492efa1f387","html_url":"https://github.com/gftf2011/clean-node-todolist","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gftf2011/clean-node-todolist","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gftf2011%2Fclean-node-todolist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gftf2011%2Fclean-node-todolist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gftf2011%2Fclean-node-todolist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gftf2011%2Fclean-node-todolist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gftf2011","download_url":"https://codeload.github.com/gftf2011/clean-node-todolist/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gftf2011%2Fclean-node-todolist/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30070087,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T01:03:42.280Z","status":"online","status_checked_at":"2026-03-04T02:00:07.464Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clean-architecture","clean-code","coveralls","cqs","design-patterns","docker","docker-compose","dockerfile","github-actions","graphql","javascript","nodejs","postgresql","rest","rest-api","sonar","sonarcloud","test","typescript"],"created_at":"2025-10-08T14:06:16.460Z","updated_at":"2026-03-04T02:32:10.922Z","avatar_url":"https://github.com/gftf2011.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\t\u003ch1\u003eCLEAN Node.JS TODOLIST • :ledger: :computer:\u003c/h1\u003e\n\u003c/div\u003e\n\n\u003cbr/\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src='https://coveralls.io/repos/github/gftf2011/clean-node-todolist/badge.svg?branch=main' alt='Coverage Status' /\u003e\n  \u003cimg src='https://sonarcloud.io/api/project_badges/measure?project=gftf2011_clean-node-todolist\u0026metric=alert_status' alt='Quality Gate Status' /\u003e\n\u003c/div\u003e\n\n\u003cbr/\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"#page_facing_up-about\"\u003eAbout\u003c/a\u003e •\n  \u003ca href=\"#hammer_and_wrench-supported-os\"\u003eSupported OS\u003c/a\u003e • \n  \u003ca href=\"#large_blue_diamond-design-patterns\"\u003eDesign Patterns\u003c/a\u003e •\n  \u003ca href=\"#blue_book-principles\"\u003ePrinciples\u003c/a\u003e •\n  \u003ca href=\"#building_construction-business-rules\"\u003eBusiness Rules\u003c/a\u003e •\n  \u003ca href=\"#clipboard-required-tools\"\u003eRequired Tools\u003c/a\u003e •\n  \u003ca href=\"#racing_car-running-project\"\u003eRunning Project\u003c/a\u003e •\n  \u003ca href=\"#test_tube-running-tests\"\u003eRunning Tests\u003c/a\u003e •\n  \u003ca href=\"#memo-license\"\u003eLicense\u003c/a\u003e\n\u003c/div\u003e\n\n\u003cbr/\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/gftf2011/clean-node-todolist/blob/main/.github/images/background.png\" /\u003e\n\u003c/div\u003e\n\n\u003cbr/\u003e\n\n## :page_facing_up: About\n\nThis a backend from a TODO LIST typescript project.\n\nThe 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 !\n\n\u003cbr/\u003e\n\n## :hammer_and_wrench: Supported OS\n\n- [x] Mac OS\n- [x] Linux\n- [x] Windows - WSL \n\n\u003cbr/\u003e\n\n## :large_blue_diamond: Design Patterns\n\n### Creational\n\n- [Abstract Factory](https://refactoring.guru/design-patterns/abstract-factory)\n- [Factory Method](https://refactoring.guru/design-patterns/factory-method)\n- [Builder](https://refactoring.guru/design-patterns/builder)\n- [Singleton](https://refactoring.guru/design-patterns/singleton)\n\n\n### Structural\n\n- [Adapter](https://refactoring.guru/design-patterns/adapter)\n- [Composite](https://refactoring.guru/design-patterns/composite)\n- [Decorator](https://refactoring.guru/design-patterns/decorator)\n- [Proxy](https://refactoring.guru/design-patterns/proxy)\n\n### Behavioral\n\n- [Chain of responsability](https://refactoring.guru/design-patterns/chain-of-responsibility)\n- [Command](https://refactoring.guru/design-patterns/command)\n- [Mediator](https://refactoring.guru/design-patterns/mediator)\n- [Strategy](https://refactoring.guru/design-patterns/strategy)\n- [Template method](https://refactoring.guru/design-patterns/template-method)\n\n### Non GOF - Gang of Four - Official\n\n- [Monad Either](https://itnext.io/either-monad-a-functional-approach-to-error-handling-in-js-ffdc2917ab2)\n\n\u003cbr/\u003e\n\n## :blue_book: Principles\n\n- [Single Responsibility Principle (SRP)](https://en.wikipedia.org/wiki/Single-responsibility_principle)\n- [Open Closed Principle (OCP)](https://en.wikipedia.org/wiki/Open%E2%80%93closed_principle)\n- [Liskov Substitution Principle (LSP)](https://en.wikipedia.org/wiki/Liskov_substitution_principle)\n- [Interface Segregation Principle (ISP)](https://en.wikipedia.org/wiki/Interface_segregation_principle)\n- [Dependency Inversion Principle (DIP)](https://en.wikipedia.org/wiki/Dependency_inversion_principle)\n- [Separation of Concerns (SOC)](https://en.wikipedia.org/wiki/Separation_of_concerns)\n- [Don't Repeat Yourself (DRY)](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself)\n- [You Aren't Gonna Need It (YAGNI)](https://en.wikipedia.org/wiki/You_aren%27t_gonna_need_it)\n- [Keep It Simple, Stupid (KISS)](https://en.wikipedia.org/wiki/KISS_principle)\n- [Composition Over Inheritance](https://en.wikipedia.org/wiki/Composition_over_inheritance)\n\n\u003cbr/\u003e\n\n## :building_construction: Business Rules\n\n- [Sign-Up](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/sign-up.md)\n- [Sign-In](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/sign-in.md)\n- [Find Note](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/find-note.md)\n- [Find Note By User ID](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/find-notes-by-user-id.md)\n- [Create Note](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/create-note.md)\n- [Update Note](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/update-note.md)\n- [Update Note Finishing Status](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/update-finished-note.md)\n- [Delete Note](https://github.com/gftf2011/clean-node-todolist/tree/main/requirements/delete-note.md)\n\n\u003cbr/\u003e\n\n## :clipboard: Required Tools\n\n- [x] Node - [https://nodejs.org/](https://nodejs.org/)\n  - Node version: 18.x.x\n  - npm version: 9.x.x\n- [x] Docker - [https://www.docker.com/](https://www.docker.com/)\n\n\u003cbr/\u003e\n\n## :racing_car: Running Project\n```sh\n  $ npm i\n  $ npm run start:dev\n```\n\n### OBS.: Ensure to install all dependencies in \u003ca href=\"#clipboard-required-tools\"\u003eRequired Tools\u003c/a\u003e\n\n\u003cbr/\u003e\n\n## :test_tube: Running Tests\n\n\u003e ### Unit Tests\n```sh\n  $ npm run test:unit\n```\n\n\u003e ### Integration Tests\n```sh\n  $ npm run test:integration\n```\n\n\u003e ### E2E Tests\n```sh\n  $ npm run test:e2e\n```\n\n\u003e ### Full Test Coverage Report\n```sh\n  $ npm run test\n```\n\n\u003cbr/\u003e\n\n## :memo: License\n\nThis project is under MIT license. See the [LICENSE](https://github.com/gftf2011/clean-node-todolist/blob/main/LICENSE) file for more details.\n\n---\n\nMade with lots of :heart: by [Gabriel Ferrari Tarallo Ferraz](https://www.linkedin.com/in/gabriel-ferrari-tarallo-ferraz/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgftf2011%2Fclean-node-todolist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgftf2011%2Fclean-node-todolist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgftf2011%2Fclean-node-todolist/lists"}