{"id":19514199,"url":"https://github.com/ayresmonteiro/reinforcer","last_synced_at":"2026-06-11T04:31:18.228Z","repository":{"id":180215183,"uuid":"664791521","full_name":"AyresMonteiro/reinforcer","owner":"AyresMonteiro","description":"A REST API made with TypeScript Clean Architecture for a quiz app.","archived":false,"fork":false,"pushed_at":"2023-11-21T09:49:54.000Z","size":541,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-08T12:15:56.977Z","etag":null,"topics":["clean-architecture","clean-code","rest-api","tests","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AyresMonteiro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-07-10T18:56:25.000Z","updated_at":"2023-11-16T17:19:19.000Z","dependencies_parsed_at":"2023-11-21T10:42:40.814Z","dependency_job_id":null,"html_url":"https://github.com/AyresMonteiro/reinforcer","commit_stats":null,"previous_names":["ayresmonteiro/reinforcer"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AyresMonteiro%2Freinforcer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AyresMonteiro%2Freinforcer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AyresMonteiro%2Freinforcer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AyresMonteiro%2Freinforcer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AyresMonteiro","download_url":"https://codeload.github.com/AyresMonteiro/reinforcer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240762528,"owners_count":19853498,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","rest-api","tests","typescript"],"created_at":"2024-11-10T23:35:28.126Z","updated_at":"2026-06-11T04:31:18.200Z","avatar_url":"https://github.com/AyresMonteiro.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Reinforcer, a base backend for quiz apps.\n\n## How to run\n\n- **Prerequisites**: Have node.js v16 or above and yarn package manager installed in your environment.\n\nRun command on your terminal:\n\n    $ yarn install \u0026\u0026 yarn build \u0026\u0026 yarn start\n\n\n## The Architecture\n\nOur app is based on simple principles:\n\n- We should can easily read and understand the code.\n- We should can easily read and understand the commit history.\n- We should can easily add a new feature.\n- We should can easily modify an old feature.\n- We should can easily change a dependency, without breaking the previous features.\n\nTo accomplish these principles, we will use the Test-Driven Development philosophy and the following architecture:\n\nThe **domain** layer constitutes the abstract idea of the main entities our application will use, so, there we have the interfaces and base classes of them. (`domain/types` and `domain/entities`).\n\nThe **data** layer constitutes base actions of these entities and actions performed over other types of data (i.e.: string hash), so there will have contracts that describe these actions. (i.e: `data/\u003centity|type\u003e/save`).\n\nThe **application** layer constitutes actions that provides real value to the entire system (the business' logic) so there will be the usecases (final compound actions). (i.e.: `application/usecases`).\n\nThe **infra** layer will implement the **data** layer actions, using types and entities and, of course, external/dependency-based code.\n\nThe **main** layer will just wrap everything, maybe making use of the concept of `adapters`: pieces of code that provides communication between our app API and some external API (i.e: an `ExpressAdapter` class could wrap a usecase to an `Express.js` route, making possible the use of a REST API).\n\nThe layers will be under `src` directory and the tests will be under `test` directory.\n\n## Archictecture Illustration\n\n![Reinforcer Architecture](https://raw.githubusercontent.com/AyresMonteiro/reinforcer/main/static/clean-arch.jpg)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayresmonteiro%2Freinforcer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fayresmonteiro%2Freinforcer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayresmonteiro%2Freinforcer/lists"}