{"id":17967176,"url":"https://github.com/timrutte/go-grpc-api-template","last_synced_at":"2026-05-16T13:02:42.028Z","repository":{"id":259984197,"uuid":"879731651","full_name":"TimRutte/go-grpc-api-template","owner":"TimRutte","description":"Go template for building a gRPC API microservice with REST support, showcasing best practices and a clean project structure.","archived":false,"fork":false,"pushed_at":"2024-10-30T13:04:59.000Z","size":99,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-17T00:13:39.484Z","etag":null,"topics":["api","go","golang","grpc","template-project"],"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/TimRutte.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":"2024-10-28T13:02:34.000Z","updated_at":"2024-10-30T18:23:32.000Z","dependencies_parsed_at":"2024-10-28T23:37:30.721Z","dependency_job_id":null,"html_url":"https://github.com/TimRutte/go-grpc-api-template","commit_stats":null,"previous_names":["timrutte/go-grpc-api-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimRutte%2Fgo-grpc-api-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimRutte%2Fgo-grpc-api-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimRutte%2Fgo-grpc-api-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimRutte%2Fgo-grpc-api-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TimRutte","download_url":"https://codeload.github.com/TimRutte/go-grpc-api-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230043145,"owners_count":18163966,"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","go","golang","grpc","template-project"],"created_at":"2024-10-29T14:04:25.919Z","updated_at":"2026-05-16T13:02:41.966Z","avatar_url":"https://github.com/TimRutte.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gRPC API Template\n\nThis repository provides a template for implementing a gRPC API in Go, which can also be accessed via REST. It demonstrates a well-structured project layout that adheres to best practices in Go development.\n\n## Table of Contents\n\n- [Features](#features)\n- [Project Structure](#project-structure)\n- [Getting Started](#getting-started)\n- [Building and Running](#building-and-running)\n- [Testing](#testing)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n\n- **gRPC API**: Fast and efficient remote procedure calls.\n- **RESTful Access**: Access the same functionality through RESTful endpoints.\n- **Best Practices**: Organized project structure for maintainability and scalability.\n- **Integrated Testing**: Unit and integration tests to ensure code quality.\n- **Protobuf Definitions**: Clear and structured API definitions using Protocol Buffers.\n\n## Getting Started\n\n### Prerequisites\n\n- Go 1.18 or later\n- Protobuf compiler (`protoc`)\n  ```bash\n  brew install protobuf # for mac\n  ```\n    ```bash\n  pip install protobuf # for linux\n  ```\n- gRPC and related Go libraries\n  ```bash\n  go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest\n  go install google.golang.org/protobuf/cmd/protoc-gen-go@latest\n  go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest\n  ```\n- Pre-commit\n  ```bash\n  brew install pre-commit # for mac\n  ```\n  ```bash\n  pip install pre-commit # for linux\n  ```\n\n### Installation\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/TimRutte/api.git\n   cd api\n   ```\n\n2. Install dependencies:\n\n   ```bash\n   make tidy\n   ```\n\n3. Install necessary Go tools:\n\n   ```bash\n\tgo install golang.org/x/tools/cmd/goimports@latest\n\tgo install github.com/golangci/golangci-lint/cmd/golangci-lint@latest\n\tgo install honnef.co/go/tools/cmd/staticcheck@latest\n   ```\n\n## Building and Running\n\nTo build and run the application, use the following commands:\n\n```bash\nmake build-linux\n```\n```bash\nmake build-darwin\n```\n```bash\nmake build-windows\n```\n\n\n```bash\nmake run\n```\n\n### Docker\n\nTo run the application in a Docker container, build the image:\n\n```bash\nmake docker-build\n```\n\nThen run the container:\n\n```bash\nmake docker-run\n```\n\n## Testing\n\nUnit tests and integration tests are included in the project. To run the tests with vulnerability check, use:\n\n```bash\nmake test\n```\n\nTo run only the unit tests:\n\n```bash\nmake test-only\n```\n\n## Contributing\n\nContributions are welcome! If you find any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimrutte%2Fgo-grpc-api-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimrutte%2Fgo-grpc-api-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimrutte%2Fgo-grpc-api-template/lists"}