{"id":22970328,"url":"https://github.com/iqhater/clean-arch-basic-example","last_synced_at":"2025-04-02T06:14:03.759Z","repository":{"id":267969274,"uuid":"902916638","full_name":"iqhater/clean-arch-basic-example","owner":"iqhater","description":"Basic greeter API service example (clean arch)","archived":false,"fork":false,"pushed_at":"2025-01-16T18:29:48.000Z","size":4383,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-07T20:33:52.314Z","etag":null,"topics":["api","clean-arch","clean-architecture-template","example","go","golang","openapi","redoc","taskfile"],"latest_commit_sha":null,"homepage":"","language":"Go","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/iqhater.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":"2024-12-13T14:34:04.000Z","updated_at":"2025-01-16T18:29:49.000Z","dependencies_parsed_at":"2024-12-13T16:29:38.860Z","dependency_job_id":"9b2f4051-43a4-4d6c-b9ee-3120814a949b","html_url":"https://github.com/iqhater/clean-arch-basic-example","commit_stats":null,"previous_names":["iqhater/clean-arch-basic-example"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iqhater%2Fclean-arch-basic-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iqhater%2Fclean-arch-basic-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iqhater%2Fclean-arch-basic-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iqhater%2Fclean-arch-basic-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iqhater","download_url":"https://codeload.github.com/iqhater/clean-arch-basic-example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246763956,"owners_count":20829800,"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":["api","clean-arch","clean-architecture-template","example","go","golang","openapi","redoc","taskfile"],"created_at":"2024-12-14T22:12:17.114Z","updated_at":"2025-04-02T06:14:03.744Z","avatar_url":"https://github.com/iqhater.png","language":"Go","readme":"\u003c!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 --\u003e\n\u003ca id=\"readme-top\"\u003e\u003c/a\u003e\n\u003c!--\n*** Thanks for checking out the Best-README-Template. If you have a suggestion\n*** that would make this better, please fork the repo and create a pull request\n*** or simply open an issue with the tag \"enhancement\".\n*** Don't forget to give the project a star!\n*** Thanks again! Now go create something AMAZING! :D\n--\u003e\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n[![Tests][tests-shield]][tests-url]\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003c!-- \u003ca href=\"https://github.com/iqhater/clean-arch-basic-example\"\u003e\n    \u003cimg src=\"clean_arch_concept_go_vector.svg\" alt=\"Logo\" width=\"80\" height=\"80\"\u003e\n  \u003c/a\u003e --\u003e\n\n\u003ch3 align=\"center\"\u003eClean Arch Basic Example\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    Clean architecture with a basic greeter API service example\n    \u003cbr /\u003e\n    \u003c!-- \u003ca href=\"https://github.com/iqhater/clean-arch-basic-example\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e --\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/iqhater/clean-arch-basic-example\"\u003eView Example\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/iqhater/clean-arch-basic-example/issues/new?labels=bug\u0026template=bug-report---.md\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/iqhater/clean-arch-basic-example/issues/new?labels=enhancement\u0026template=feature-request---.md\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\nGraph generated by `go-arch-lint` utility\n[![Product Name Screen Shot][product-screenshot]](https://example.com)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Built With\n\n* [![Go][go.dev]][Go-url]\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nSetting up your project locally.\nTo get a local copy up and running follow these simple example steps.\n\n### Prerequisites\n\nPrepare some useful tools for project development\n\n* install project dependencies (Taskfile and go-arch-lint)\n\n[Taskfile](https://taskfile.dev/installation/) _`*recommended`_ \u003c/br\u003e\n[golangci-lint](https://golangci-lint.run/welcome/install/) _*optional_ \u003c/br\u003e\n[go-arch-lint](https://github.com/fe3dback/go-arch-lint) _*optional_\n\n### Installation\n\n1. Clone the repo\n\n   ```sh\n   git clone https://github.com/iqhater/clean-arch-basic-example.git\n   ```\n\n2. Install project dependencies\n\n   ```sh\n   task install\n   ```\n\n3. Add `.env` file to project root. See `.env.example`\n\n4. *Optional Feel free to edit `Taskfile` binary name, module name and entrypoint path if you wish.\n\n   ```yml\n    MODULE_NAME: greeter_api\n\n    # Binary name\n    BINARY_NAME: greeter_api\n\n    # App entrypoint path\n    APP_ENTRYPOINT: ./cmd/greeter\n   ```\n\n5. Build and run project\n\n   ```sh\n   task run\n   ```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\nClean arch data flow concept schema\n[![Clean Arch Schema Concept][schema-concept]](https://bloghugocoutinho.wordpress.com/wp-content/uploads/2020/05/cleanarchitecture-1.jpg)\n\n#### Request public greeting example\n\n```sh\ncurl \"http://localhost:8080/greet?name=Bob\"\n```\n\n#### Response\n\n```json\n{\n  \"request_id\":\"1ddb50f2-6fde-4fda-9d5c-51a23fcaa935\",\n  \"greeting\":\"👋 Hello Gopher Bob!\"\n}\n```\n\n#### Request private greeting example\n\n```sh\ncurl \"http://localhost:8080/greet/1?name=Bob\"\n```\n\n#### Response with counter\n\n```json\n{\n  \"id\":1,\n  \"greeting\":\"👋 Hello Gopher Bob!\",\n  \"total_greetings\":3\n}\n```\n\n### Taskfile useful commands\n\nRun all tests\n\n```sh\ntask test\n```\n\nRun project linter\n\n```sh\ntask lint\n```\n\nRemove all binaries\n\n```sh\ntask clean\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n\n* [ ] Deploy openapi static docs located at the `/api` folder\n* [ ] Deploy greeter API service\n\nSee the [open issues](https://github.com/iqhater/clean-arch-basic-example/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Top contributors\n\n\u003ca href=\"https://github.com/iqhater/clean-arch-basic-example/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=iqhater/clean-arch-basic-example\" alt=\"contrib.rocks image\" /\u003e\n\u003c/a\u003e\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE.txt` for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nemail - \u003ciqhater@yandex.ru\u003e\n\nProject Link: [https://github.com/iqhater/clean-arch-basic-example](https://github.com/iqhater/clean-arch-basic-example)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[issues-shield]: https://img.shields.io/github/issues/iqhater/clean-arch-basic-example.svg?style=for-the-badge\n[issues-url]: https://github.com/iqhater/clean-arch-basic-example/issues\n[license-shield]: https://img.shields.io/github/license/iqhater/clean-arch-basic-example.svg?style=for-the-badge\n[license-url]: https://github.com/iqhater/clean-arch-basic-example/blob/main/LICENSE.txt\n[tests-url]: https://github.com/iqhater/clean-arch-basic-example/actions/workflows/develop_run_tests.yml/badge.svg\n[tests-shield]: https://github.com/iqhater/clean-arch-basic-example/actions/workflows/develop_run_tests.yml/badge.svg\n[product-screenshot]: go-arch-lint-graph.svg\n[schema-concept]: clean_arch_concept_go_vector.svg\n[go.dev]: https://img.shields.io/badge/golang-00ADD8?style=for-the-badge\u0026logo=go\u0026logoColor=white\n[Go-url]: https://go.dev\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiqhater%2Fclean-arch-basic-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiqhater%2Fclean-arch-basic-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiqhater%2Fclean-arch-basic-example/lists"}