{"id":26487896,"url":"https://github.com/50-course/notes-tracker-go","last_synced_at":"2025-12-30T22:23:03.544Z","repository":{"id":282940014,"uuid":"950143163","full_name":"50-Course/notes-tracker-go","owner":"50-Course","description":"Simple Note Tracking Application ","archived":false,"fork":false,"pushed_at":"2025-03-19T10:05:15.000Z","size":80,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-22T21:59:22.991Z","etag":null,"topics":["bun","bunrouter","golang","microservices","todo-app"],"latest_commit_sha":null,"homepage":"","language":"Go","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/50-Course.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":"2025-03-17T17:40:40.000Z","updated_at":"2025-03-19T10:05:18.000Z","dependencies_parsed_at":"2025-03-17T19:46:40.709Z","dependency_job_id":null,"html_url":"https://github.com/50-Course/notes-tracker-go","commit_stats":null,"previous_names":["50-course/notes-tracker-go"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/50-Course/notes-tracker-go","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/50-Course%2Fnotes-tracker-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/50-Course%2Fnotes-tracker-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/50-Course%2Fnotes-tracker-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/50-Course%2Fnotes-tracker-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/50-Course","download_url":"https://codeload.github.com/50-Course/notes-tracker-go/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/50-Course%2Fnotes-tracker-go/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262076860,"owners_count":23255076,"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":["bun","bunrouter","golang","microservices","todo-app"],"created_at":"2025-03-20T06:53:49.379Z","updated_at":"2025-12-30T22:23:03.497Z","avatar_url":"https://github.com/50-Course.png","language":"Go","readme":"# Dead Simple Task tracking application\n\n### Architectural decisions:\n\n- Follows a microservices architecture\n- Uses a RESTful API for external communication and gRPC for internal communication\n- Fully containerized using Docker\n- And, Bootstrapped using Docker Compose\n\n## System Architecture\n\n```mermaid\ngraph TD;\n    subgraph \"Client\"\n        User\n    end\n\n    subgraph \"API Gateway (BunRouter)\"\n        GatewayServer[\"API Gateway (BunRouter)\"]\n    end\n\n    subgraph \"Internal Service (gRPC Server)\"\n        gRPCServer[\"gRPC Server\"]\n    end\n\n    subgraph \"Database Layer\"\n        PostgreSQL[\"PostgreSQL (Bun ORM)\"]\n    end\n\n    %% Arrows (Flow of Communication)\n    User --\u003e|REST API| GatewayServer\n    GatewayServer --\u003e|gRPC Call| gRPCServer\n    gRPCServer --\u003e|Database Queries| PostgreSQL\n    PostgreSQL --\u003e|Data Response| gRPCServer\n    gRPCServer --\u003e|gRPC Response| GatewayServer\n    GatewayServer --\u003e|HTTP Response| User\n```\n\n### **How It Works:**\n\n- **User** makes HTTP requests to the **API Gateway**.\n- **API Gateway** translates requests into **gRPC** calls to the **Internal Service**.\n- **Internal Service** communicates with **PostgreSQL** using **Bun ORM**.\n- Responses flow back **through the same pipeline** to the user.\n\n## Installation\n\n## Usage\n\nThis application is fully containerized, however, we have provided a `Makefile` to make usability easier, be it development or just exploring.\n\nTo get started, you are required to first set your environment variables in the `.env` file. You can copy the `.env.template` file and rename it to `.env` (please, keep it within the `config/` folder) and fill in the required fields.\n\nBelow are the commands you can use to interact with the application:\n\n- To hit the ground running, you can use the following command to start the application:\n\n```bash\nmake run\n```\n\nThis runs the application within a Docker container, and you can access the application on `http://localhost:8080` or a provided port of choice\nfrom your environment.\n\n- To stop the application (containerized version), you can use the following command:\n\n```bash\nmake stop\n```\n\n- To clean up the application, you can use the following command:\n\n```bash\nmake clean\n```\n\n- To run the application in development mode, you can use the following command:\n\n```bash\nmake serve\n```\n\nThis runs the application (gRPC \u0026 API Gateway (manual mode, non-Docker)) on your local machine, and you can access the application on `http://localhost:8080` or a provided port of choice from your environment.\nThis was heavily insipired by Mintlify's `mintlify dev`, Yarn's `yarn serve` and python's `python -m http.server` commands.\n\n- To start them individually, you can use the following commands:\n\n```bash\nmake grpc\n```\n\nto run the gRPC server and\n\n```bash\nmake gateway\n```\n\nto run the API Gateway.\n\n- To run the tests, you can use the following command:\n\n```bash\nmake test\n\n```\n\nFor additional commands, you can check the `Makefile` for more information. or run `make help` to see all available commands.\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F50-course%2Fnotes-tracker-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F50-course%2Fnotes-tracker-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F50-course%2Fnotes-tracker-go/lists"}