{"id":18554685,"url":"https://github.com/yudwig/echo-clean-api","last_synced_at":"2025-10-07T06:15:14.357Z","repository":{"id":203439085,"uuid":"380967898","full_name":"yudwig/echo-clean-api","owner":"yudwig","description":"A sample REST API based on clean architecture using GO framework echo.","archived":false,"fork":false,"pushed_at":"2021-06-28T11:07:08.000Z","size":62,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-17T11:14:37.308Z","etag":null,"topics":["clean-architecture","echo","echo-framework","go","golang","ishell"],"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/yudwig.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}},"created_at":"2021-06-28T08:56:07.000Z","updated_at":"2021-06-28T11:08:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"8da9bd88-fbe1-49e0-b904-b78fd30924cf","html_url":"https://github.com/yudwig/echo-clean-api","commit_stats":null,"previous_names":["yudwig/echo-clean-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yudwig%2Fecho-clean-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yudwig%2Fecho-clean-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yudwig%2Fecho-clean-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yudwig%2Fecho-clean-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yudwig","download_url":"https://codeload.github.com/yudwig/echo-clean-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254337606,"owners_count":22054254,"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","echo","echo-framework","go","golang","ishell"],"created_at":"2024-11-06T21:23:26.552Z","updated_at":"2025-10-07T06:15:09.339Z","avatar_url":"https://github.com/yudwig.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# echo-clean-api\nA sample REST API based on clean architecture using GO framework echo.\n\n## Features\necho-clean-api is demonstration of CRUD API for a simple user management system.\nTo test API also includes simple REPL CLI client tool.\n\n\n## How to run\n\n#### DB migration\n\nBy default, app uses local mysql DB which dns is \"root@tcp(127.0.0.1:3306)/echo\". So first, create database 'echo' before migration.\nAfter that, run migration command.\n\n```sh\ngo run main.go migrate\n```\n\n#### Run server\n\nRun echo server on \"localhost:8000\" by this command.\n\n```sh\ngo run main.go server\n```\n\n#### Run client shell\n\nRun API client tool by this command.\n\n```sh\ngo run main.go client\n```\n\nWhen started shell, command list are displayed as follows.\n\n```sh\n% go run main.go client\nClient shell start.\n\nCommands:\n  clear       clear the screen\n  create      create user. input: \u003e create {name}\n  delete      delete user. input: \u003e delete {id}\n  exit        exit the program\n  get         get user list. input: \u003e get\n  help        display help\n  update      update user name. input: \u003e update {id} {name}\n\n\u003e\u003e\u003e\n```\n\n## Directory structure\nThe application has the following directory structure.\n\n```\napp\n├── adapter\n│   ├── controller\n│   ├── interactor\n│   ├── presenter\n│   └── repository\n├── core\n│   ├── domain\n│   │   └── entity\n│   │       └── user\n│   ├── presentation\n│   │   └── response\n│   └── usecase\n└── driver\n    ├── client\n    ├── db\n    │   ├── mockdb\n    │   ├── rdb\n    │   └── seed\n    ├── echo\n    │   ├── routes\n    │   └── server\n    └── log\n```\n\nBased on the clean architecture, it has the following dependency directions.\n\n```\n ┌────────┐      ┌─────────┐      ┌────────┐  \n │ driver │ ───\u003e │ adapter │ ───\u003e │  core  │ \n └────────┘      └─────────┘      └────────┘ \n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyudwig%2Fecho-clean-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyudwig%2Fecho-clean-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyudwig%2Fecho-clean-api/lists"}