{"id":13902865,"url":"https://github.com/JamieLivingstone/node-clean-architecture","last_synced_at":"2025-07-18T00:32:26.344Z","repository":{"id":39125073,"uuid":"476395000","full_name":"JamieLivingstone/node-clean-architecture","owner":"JamieLivingstone","description":"A project template that follows the clean architecture principles and encourages established practices.","archived":false,"fork":false,"pushed_at":"2024-02-25T19:47:26.000Z","size":343,"stargazers_count":162,"open_issues_count":0,"forks_count":23,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-11-22T14:12:11.878Z","etag":null,"topics":["boilerplate","clean-architecture","fastify","node","nodejs","prisma","template","typescript","zod"],"latest_commit_sha":null,"homepage":"","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/JamieLivingstone.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}},"created_at":"2022-03-31T16:45:20.000Z","updated_at":"2024-11-16T08:30:57.000Z","dependencies_parsed_at":"2024-02-25T20:40:53.116Z","dependency_job_id":"d119b01b-98ae-43bb-a59f-862fd194078b","html_url":"https://github.com/JamieLivingstone/node-clean-architecture","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JamieLivingstone%2Fnode-clean-architecture","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JamieLivingstone%2Fnode-clean-architecture/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JamieLivingstone%2Fnode-clean-architecture/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JamieLivingstone%2Fnode-clean-architecture/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JamieLivingstone","download_url":"https://codeload.github.com/JamieLivingstone/node-clean-architecture/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226320680,"owners_count":17606343,"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":["boilerplate","clean-architecture","fastify","node","nodejs","prisma","template","typescript","zod"],"created_at":"2024-08-06T22:01:28.362Z","updated_at":"2024-11-25T11:30:45.907Z","avatar_url":"https://github.com/JamieLivingstone.png","language":"TypeScript","funding_links":[],"categories":["clean-architecture"],"sub_categories":[],"readme":"# Clean Architecture Template\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/JamieLivingstone/node-clean-architecture/blob/main/LICENSE)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/f2520d575fe754ae7032/test_coverage)](https://codeclimate.com/github/JamieLivingstone/node-clean-architecture/test_coverage)\n[![Maintainability](https://api.codeclimate.com/v1/badges/f2520d575fe754ae7032/maintainability)](https://codeclimate.com/github/JamieLivingstone/node-clean-architecture/maintainability)\n[![Known Vulnerabilities](https://snyk.io/test/github/JamieLivingstone/node-clean-architecture/badge.svg)](https://snyk.io/test/github/JamieLivingstone/node-clean-architecture)\n\nA Node template that follows the Clean Architecture principles and encourages established practices.\n\n## Features\n\n- TypeScript first\n- Dependency injection via Awilix\n- CQRS (Command Query Responsibility Segregation)\n- Automatic API documentation via Swagger\n- Built with scalability and performance in mind by using Fastify (see [benchmarks](https://www.fastify.io/benchmarks))\n- Built in logging with Pino\n- Comprehensive testing including unit and functional tests\n- Prisma ORM integration\n\n## Getting Started\n\n1. Install the latest [Node.js LTS](https://nodejs.org/en/)\n2. Install Docker and ensure that it is running\n3. Create .env file `cp .env.example .env`\n4. Install project dependencies by running `npm install`\n5. Start Docker (local Postgres instance) `docker-compose up -d`\n6. Create database `npx prisma migrate deploy`\n7. Start development server `npm run dev`\n8. Navigate to Swagger ([http://localhost:3000/api-docs](http://localhost:3000/api-docs))\n\n## Scripts\n\n**Build production bundle**\n\n```\nnpm run build\n```\n\n**Lint project (eslint)**\n\n```\nnpm run lint\n```\n\n**Start development server**\n\n```\nnpm run dev\n```\n\n**Run all tests**\n\n```\nnpm test\n```\n\n**Run unit tests**\n\n```\nnpm run test:unit\n```\n\n**Run functional tests (API tests)**\n\n```\nnpm run test:functional\n```\n\n## License\n\n[This project is licensed with the MIT license.](https://github.com/JamieLivingstone/node-clean-architecture/blob/main/LICENSE)\n\n## Credits\n\nThe project's inspiration is [Jason Taylor's clean architecture template](https://github.com/jasontaylordev/CleanArchitecture) for C#.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJamieLivingstone%2Fnode-clean-architecture","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJamieLivingstone%2Fnode-clean-architecture","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJamieLivingstone%2Fnode-clean-architecture/lists"}