{"id":19635434,"url":"https://github.com/neoxelox/service","last_synced_at":"2025-04-28T07:32:11.668Z","repository":{"id":137193765,"uuid":"243866800","full_name":"neoxelox/service","owner":"neoxelox","description":"Highly opinionated Go service.","archived":false,"fork":false,"pushed_at":"2024-09-09T14:10:29.000Z","size":259,"stargazers_count":16,"open_issues_count":0,"forks_count":5,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-05T07:41:45.649Z","etag":null,"topics":["api","cli","go","golang","http","microservice","neoxelox","service","worker"],"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/neoxelox.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":"2020-02-28T22:37:37.000Z","updated_at":"2024-09-09T14:10:33.000Z","dependencies_parsed_at":"2024-04-29T12:30:14.769Z","dependency_job_id":"e113445a-68b5-460a-88d2-30bd6d397914","html_url":"https://github.com/neoxelox/service","commit_stats":null,"previous_names":["neoxelox/service","neoxelox/microservice-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoxelox%2Fservice","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoxelox%2Fservice/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoxelox%2Fservice/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoxelox%2Fservice/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neoxelox","download_url":"https://codeload.github.com/neoxelox/service/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251271359,"owners_count":21562529,"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","cli","go","golang","http","microservice","neoxelox","service","worker"],"created_at":"2024-11-11T12:25:14.836Z","updated_at":"2025-04-28T07:32:11.088Z","avatar_url":"https://github.com/neoxelox.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# service\n\n**`Highly opinionated Go service.`** 🐻\n\n## What\n\nThis is a complete over-engineered Golang service template, which strongly relies on the building blocks of my (also) [**`highly opinionated Go backend kit`**](https://github.com/neoxelox/kit).\n\n\u003e This template is already being used by some companies on production, handling non-trivial volumes of traffic. However, use it at your own \"risk\", this is a personal project and support is not the main intention.\n\n## Features\n\nThis repository packs so many features that I am unable to sit down and list them all : ). Feel free to take a look at the code.\n\n## Before Getting Started\n\n### Development\n\nMake a copy of `envs/dev/.env.example` to `envs/dev/.env` and fill the variables. `envs/dev/.env` is an ignored file so you won't have the chance to commit it with potential production values 😉.\n\nAlso, to setup the environment, follow these steps:\n\n1. Install dependencies: `pip install -r scripts/requirements.txt`\n2. Install tools `inv tool.install --include \"dev*\"`\n\nRun `inv help` for further commands and `inv \u003ccommand\u003e --help` for their usage.\n\n### Production\n\nTo make this environment work you will have to make the following changes:\n\n1. Make a copy of `envs/prod/.env.example` to `envs/prod/.env` (which is ignored) and fill the variables.\n\n2. Create 2 [Cloudflare Tunnels](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/), one for exterior user accessible services `ext`, and the other for interior company-only accessible services and tools `int`.\n\n3. Download both Tunnels certificates to `envs/prod/certs/` (which is ignored).\n\n4. Fill both Tunnels configuration files `envs/prod/cloudflared-ext.yaml \u0026 cloudflared-int.yaml` with the Tunnel ID, credentials path and hostnames.\n\n5. Change the `scripts/tasks.py` `build \u0026 deploy` tasks to tag and push your service images to your registry of preference (it should be a private registry...).\n\n6) Finally, fill the `envs/prod/docker-compose.yaml` so the service containers point to your own registry images.\n\n## Contribute\n\nFeel free to contribute to this project : ) .\n\n## License\n\nThis project is licensed under the [MIT License](https://opensource.org/licenses/MIT) - read the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneoxelox%2Fservice","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneoxelox%2Fservice","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneoxelox%2Fservice/lists"}