{"id":17947619,"url":"https://github.com/sayeed1999/aspnetcore.webapi.template","last_synced_at":"2025-03-24T21:32:27.104Z","repository":{"id":258776619,"uuid":"874614101","full_name":"sayeed1999/AspNetCore.WebApi.Template","owner":"sayeed1999","description":"Build any small-large scale web api in ASP.NET Core which includes Clean Architecture, CQRS, Mediatr, Functional Testing, and many more using this template.","archived":false,"fork":false,"pushed_at":"2024-10-20T17:17:17.000Z","size":132,"stargazers_count":3,"open_issues_count":5,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-29T08:06:00.101Z","etag":null,"topics":["asp-net-core","clean-architecture","docker","dotnet-core","functional-testing","hacktoberfest","template-project","unit-test","webapi"],"latest_commit_sha":null,"homepage":"","language":"C#","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/sayeed1999.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2024-10-18T06:37:38.000Z","updated_at":"2024-10-20T17:17:20.000Z","dependencies_parsed_at":"2024-10-20T18:55:28.692Z","dependency_job_id":null,"html_url":"https://github.com/sayeed1999/AspNetCore.WebApi.Template","commit_stats":null,"previous_names":["sayeed1999/aspnetcore.webapi.template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sayeed1999%2FAspNetCore.WebApi.Template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sayeed1999%2FAspNetCore.WebApi.Template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sayeed1999%2FAspNetCore.WebApi.Template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sayeed1999%2FAspNetCore.WebApi.Template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sayeed1999","download_url":"https://codeload.github.com/sayeed1999/AspNetCore.WebApi.Template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245355586,"owners_count":20601755,"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":["asp-net-core","clean-architecture","docker","dotnet-core","functional-testing","hacktoberfest","template-project","unit-test","webapi"],"created_at":"2024-10-29T08:06:01.899Z","updated_at":"2025-03-24T21:32:27.073Z","avatar_url":"https://github.com/sayeed1999.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ASP.NET Core Web API Template\n\n**AspNetCore.WebApi.Template** is an open-source project to speed up the API development process of any small-large scale application in ASP.NET Core. This comes with out-of-the box prebuilt setups including -\n\n- **ASP.NET Core** Web API with **PostgreSQL** database\n- **Docker** container support with hot reloading support for local development\n- **Clean Architecture** with **FluentValidation**, **CQRS** and **Mediatr**\n- **OData** integration support\n- Sample code for **CRUD operation** on Products, Categories\n- Sample code for **functional testing** of business usecases\n- \u003ci\u003eany many more..\u003c/i\u003e\n\n## Table of Contents\n\n- [Architecture](#architecture)\n- [Set Up Environment Variables](#set-up-environment-variables)\n- [Run with Docker](#run-with-docker)\n- [Add a Migration](#add-a-migration)\n- [Contribute to this Project](#contribute-to-this-project)\n- [Special Thanks](#special-thanks)\n\n## Architecture\n\nThis project is built on top of **Clean Architecture** with **CQRS** and **Mediator** pattern in **ASP.NET Core**.\n\nTo get a high-level overview of the responsibilites each of the layers in this project, please refer to -\n\n- [Presentation Layer](src/Web/README.md)\n- [Application Layer](src/Application/README.md)\n- [Infrastructure Layer](src/Infrastructure/README.md)\n- [Domain Layer](src/Domain/README.md)\n\n## Set Up Environment Variables\n\n- Clone the repository \u0026 navigate to project root directory.\n\n- Set necessary environment variables in your machine by following the .env.example file e.g\n\n```bash\nexport POSTGRES_USER=xxx\nexport POSTGRES_PASSWORD=xxx\nexport PGADMIN_EMAIL=xxx\nexport PGADMIN_PASSWORD=xxx\n```\n\n## Run with Docker\n\n- Ensure Docker is installed on your system.\n\n- Run the docker containers using the following command.\n\n```bash\ndocker compose -f docker-compose.local.yml up -d\n```\n\n- Hit the healthcheck endpoint to see API is working on not.\n\n```\nURI: /GET localhost:5000/health\n```\n\n- Test hot reloading working or not inside Docker container.\n\nChange any code (comment out a single endpoint) and save the code and see docker container has updated on real-tme.\n\n- Stop the docker container using the following command.\n\n```bash\ndocker compose -f docker-compose.local.yml down\n```\n\n## Add a Migration\n\nRun the following command to add a migration\n\n```bash\ndotnet ef migrations add \u003cMigration_Name\u003e --project ./src/Infrastructure --startup-project ./src/Web --output-dir ./Data/Migrations\n```\n\n## Contribute to this Project\n\nPlease refer to contribution guide [page](./CONTRIBUTING.md).\n\n## Special Thanks\n\nI used the following two templates to start my own template:\n\n- [jasontaylordev/CleanArchitecture](https://github.com/jasontaylordev/CleanArchitecture)\n- [jasontaylordev/NorthwindTraders](https://github.com/jasontaylordev/NorthwindTraders)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsayeed1999%2Faspnetcore.webapi.template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsayeed1999%2Faspnetcore.webapi.template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsayeed1999%2Faspnetcore.webapi.template/lists"}