{"id":31737474,"url":"https://github.com/tech-preta/alderaan","last_synced_at":"2026-04-12T22:32:59.850Z","repository":{"id":318235412,"uuid":"1069954348","full_name":"Tech-Preta/alderaan","owner":"Tech-Preta","description":null,"archived":false,"fork":false,"pushed_at":"2025-10-06T00:17:23.000Z","size":178,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-06T01:16:04.950Z","etag":null,"topics":["ddd-architecture","gin","golang"],"latest_commit_sha":null,"homepage":"https://nataliagranato.xyz","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tech-Preta.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"nataliagranato","ko_fi":"nataliagranato","buy_me_a_coffee":"nataliagranato","pix":"fada126d-7311-495f-bda2-55ec79b0a39b"}},"created_at":"2025-10-05T00:33:33.000Z","updated_at":"2025-10-05T23:29:20.000Z","dependencies_parsed_at":"2025-10-06T01:16:09.458Z","dependency_job_id":"4861edae-1bef-405d-aefb-03a65ac7111f","html_url":"https://github.com/Tech-Preta/alderaan","commit_stats":null,"previous_names":["tech-preta/alderaan"],"tags_count":null,"template":false,"template_full_name":"Tech-Preta/repository-sample","purl":"pkg:github/Tech-Preta/alderaan","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tech-Preta%2Falderaan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tech-Preta%2Falderaan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tech-Preta%2Falderaan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tech-Preta%2Falderaan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tech-Preta","download_url":"https://codeload.github.com/Tech-Preta/alderaan/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tech-Preta%2Falderaan/sbom","scorecard":{"id":1238526,"data":{"date":"2025-10-05T23:29:03Z","repo":{"name":"github.com/Tech-Preta/alderaan","commit":"c58a7a04bd56a10f76a5c961983d2e9c084744c6"},"scorecard":{"version":"v5.3.0","commit":"c22063e786c11f9dd714d777a687ff7c4599b600"},"score":4.8,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/3 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"project was created within the last 90 days. Please review its contents carefully","details":["Warn: Repository was created within the last 90 days."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#dangerous-workflow"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#security-policy"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#binary-artifacts"}},{"name":"Dependency-Update-Tool","score":10,"reason":"update tool detected","details":["Info: detected update tool: Dependabot: .github/dependabot.yml:1"],"documentation":{"short":"Determines if the project uses a dependency update tool.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#dependency-update-tool"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/dependabot.yml:1","Info: topLevel 'contents' permission set to 'read': .github/workflows/dependency-review.yml:13","Info: topLevel 'contents' permission set to 'read': .github/workflows/issue.yml:7","Warn: topLevel 'security-events' permission set to 'write': .github/workflows/osv-scanner.yml:26","Info: topLevel 'contents' permission set to 'read': .github/workflows/osv-scanner.yml:28","Info: topLevel permissions set to 'read-all': .github/workflows/scorecard.yml:18","Warn: topLevel 'contents' permission set to 'write': .github/workflows/trivy.yml:9","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#token-permissions"}},{"name":"CI-Tests","score":-1,"reason":"no pull request found","details":null,"documentation":{"short":"Determines if the project runs tests before pull requests are merged.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#ci-tests"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":6,"reason":"dependency not pinned by hash detected -- score normalized to 6","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/trivy.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Tech-Preta/alderaan/trivy.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/trivy.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/Tech-Preta/alderaan/trivy.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:4: pin your Docker image by updating golang:1.24-alpine to golang:1.24-alpine@sha256:fc2cff6625f3c1c92e6c85938ac5bd09034ad0d4bc2dfb08278020b68540dbb5","Warn: containerImage not pinned by hash: Dockerfile:34: pin your Docker image by updating alpine:3.19 to alpine:3.19@sha256:3be987e6cde1d07e873c012bf6cfe941e6e85d16ca5fc5b8bedc675451d2de67","Warn: goCommand not pinned by hash: Dockerfile:22","Info:   5 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   7 out of   8 third-party GitHubAction dependencies pinned","Info:   0 out of   2 containerImage dependencies pinned","Info:   0 out of   1 goCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#signed-releases"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#license"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#vulnerabilities"}},{"name":"Contributors","score":0,"reason":"project has 0 contributing companies or organizations -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project has a set of contributors from multiple organizations (e.g., companies).","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#contributors"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-10-06T01:22:04.725Z","repository_id":318235412,"created_at":"2025-10-06T01:22:04.725Z","updated_at":"2025-10-06T01:22:04.725Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001123,"owners_count":26083021,"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","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["ddd-architecture","gin","golang"],"created_at":"2025-10-09T09:22:02.301Z","updated_at":"2026-04-12T22:32:59.842Z","avatar_url":"https://github.com/Tech-Preta.png","language":"Go","funding_links":["https://github.com/sponsors/nataliagranato","https://ko-fi.com/nataliagranato","https://buymeacoffee.com/nataliagranato","fada126d-7311-495f-bda2-55ec79b0a39b"],"categories":[],"sub_categories":[],"readme":"# Servidor HTTP com Domain Driven Design, Gin e Shutdown Controlado\n\nEste projeto demonstra como criar um servidor HTTP completo com Domain-Driven Design (DDD), usando Gin e implementando um graceful shutdown.\n\n## 📋 Estrutura do Projeto\n\n```\n.\n├── cmd\n│   └── main.go\n├── go.mod\n├── go.sum\n├── internal\n│   ├── domain\n│   │   └── product\n│   │       ├── entity\n│   │       │   └── product.go\n│   │       ├── events\n│   │       │   └── product_created_event.go\n│   │       └── repository\n│   │           └── product_repository.go\n│   ├── infra\n│   │   └── http\n│   │       ├── handlers\n│   │       │   └── product_handler.go\n│   │       └── router\n│   │           └── product_router.go\n│   └── shared\n│       └── domain\n│           └── events\n│               └── events_handler.go\n└── README.md\n```\n\n## 🎯 Características\n\n- **Domínio puro e desacoplado**: Entidades de domínio com validação integrada\n- **Repositório thread-safe**: Usando `sync.RWMutex` para acesso concorrente seguro\n- **Dispatcher de eventos de domínio**: Sistema de eventos para extensibilidade\n- **Graceful shutdown**: Encerramento controlado respeitando requisições em andamento\n- **Arquitetura limpa**: Separação clara entre camadas de domínio, aplicação e infraestrutura\n- **Flyway Migrations**: Versionamento automático e rastreável do schema do banco\n\n## 🚀 Como Executar\n\n### Pré-requisitos\n\n- Go 1.23 ou superior\n\n### Instalação\n\n1. Clone o repositório\n2. Instale as dependências:\n\n```bash\ngo mod download\n```\n\n3. **Configurar banco de dados:**\n\n```bash\n# Copiar arquivo de configuração\ncp config.env.example config.env\n\n# Editar se necessário (valores padrão já funcionam)\n# vim config.env\n\n# Iniciar PostgreSQL\nmake db-up\n\n# Aguardar ~10 segundos para migrations rodarem automaticamente\n```\n\n4. **Execute a API:**\n\n**Opção 1:** Com Makefile (recomendado):\n\n```bash\nmake run\n```\n\n**Opção 2:** Diretamente:\n\n```bash\ngo run cmd/main.go\n```\n\nO servidor estará disponível em `http://localhost:8080`\n\n### Comandos Úteis\n\n```bash\nmake help           # Ver todos os comandos disponíveis\nmake swagger        # Gerar documentação Swagger\nmake build          # Compilar binário\nmake run            # Executar com auto-geração de docs\nmake dev            # Executar sem regenerar docs\nmake clean          # Limpar binários\nmake test           # Executar testes\n\n# Banco de dados\nmake db-up          # Iniciar PostgreSQL\nmake db-down        # Parar PostgreSQL\nmake db-connect     # Conectar ao banco\nmake db-seed        # Popular com dados\nmake db-clean       # Limpar dados\nmake db-reset       # Resetar banco\n\n# Plataforma completa\nmake platform-up    # Inicia tudo (DB + API + Monitoring)\nmake platform-down  # Para tudo\nmake platform-logs  # Ver logs de tudo\nmake platform-status # Status dos serviços\n```\n\n## 📚 Documentação Interativa (Swagger)\n\nAcesse a documentação interativa da API em:\n\n```\nhttp://localhost:8080/swagger/index.html\n```\n\nVocê pode testar todos os endpoints diretamente pelo navegador! 🎯\n\n## 📡 Endpoints da API\n\n### Criar Produto\n\n```bash\ncurl -X POST http://localhost:8080/api/v1/products \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"name\": \"Notebook\",\n    \"sku\": 12345,\n    \"categories\": [\"Eletrônicos\", \"Computadores\"],\n    \"price\": 3500\n  }'\n```\n\n### Listar Todos os Produtos\n\n```bash\ncurl http://localhost:8080/api/v1/products\n```\n\n### Buscar Produto por Nome\n\n```bash\ncurl http://localhost:8080/api/v1/products/Notebook\n```\n\n## 🏗️ Arquitetura\n\n### Camada de Domínio\n\n- **Entidade Product**: Representa um produto com validações de negócio\n- **ProductCreatedEvent**: Evento disparado quando um produto é criado\n- **ProductRepository**: Interface e implementação para persistência de produtos\n\n### Camada de Infraestrutura\n\n- **ProductHandler**: Handlers HTTP para operações com produtos\n- **Router**: Configuração de rotas da API\n\n### Camada Compartilhada\n\n- **EventDispatcher**: Sistema de eventos para comunicação entre componentes\n\n## 🛡️ Graceful Shutdown\n\nO servidor implementa um shutdown controlado que:\n\n1. Captura sinais de terminação (SIGINT, SIGTERM)\n2. Aguarda até 5 segundos para finalizar requisições em andamento\n3. Encerra o servidor de forma limpa\n\nPara testar, execute o servidor e pressione `Ctrl+C`. Você verá:\n\n```\nReceived termination signal. Shutting down server...\nServer shut down gracefully.\n```\n\n## 🎯 Características implementadas\n\n- ✅ **Arquitetura Limpa** - Separação clara entre camadas\n- ✅ **DDD** - Domain-Driven Design com entidades ricas\n- ✅ **Persistência PostgreSQL** - Dados persistidos em banco relacional\n- ✅ **Migrations** - Controle de versão do schema do banco\n- ✅ **Thread-Safe** - Repositório com proteção para concorrência\n- ✅ **Event Dispatcher** - Sistema de eventos de domínio\n- ✅ **Graceful Shutdown** - Encerramento controlado com fechamento do banco\n- ✅ **RESTful API** - Endpoints bem definidos com Gin\n- ✅ **Swagger/OpenAPI** - Documentação interativa automática\n- ✅ **Prometheus Monitoring** - Golden Signals + métricas de negócio\n\n## 📊 Monitoramento (Prometheus + Grafana)\n\n### Métricas Disponíveis\n\n**Golden Signals (Google SRE):**\n- 🕐 **Latency**: Tempo de resposta das requisições\n- 📈 **Traffic**: Taxa de requisições por segundo\n- ❌ **Errors**: Taxa de erros (4xx, 5xx)\n- 📊 **Saturation**: Requisições simultâneas\n\n**Métricas de Negócio:**\n- Produtos criados (total e taxa)\n- Total de produtos em estoque\n- Produtos por categoria\n- Valor total do inventário\n- Preço médio dos produtos\n\n### Acessar Métricas\n\n```\nhttp://localhost:8080/metrics  # Endpoint Prometheus\n```\n\n### Iniciar Stack Completa (Tudo de Uma Vez)\n\n```bash\n# Inicia PostgreSQL + API + Prometheus + Grafana\ndocker-compose up -d\n\n# Ou use o Makefile\nmake platform-up\n```\n\nAcesse:\n- **API**: `http://localhost:8080`\n- **Swagger**: `http://localhost:8080/swagger/index.html`\n- **Prometheus**: `http://localhost:9090`\n- **Grafana**: `http://localhost:3000` (admin/admin)\n- **PostgreSQL**: `localhost:5432`\n\n📖 [**Guia completo de monitoramento →**](monitoring/README.md)\n\n## 📚 Tecnologias Utilizadas\n\n- **Go 1.24**: Linguagem de programação\n- **Gin**: Framework web de alta performance\n- **PostgreSQL**: Banco de dados relacional\n- **Prometheus**: Sistema de monitoramento e métricas\n- **Swagger/OpenAPI**: Documentação interativa da API\n- **Flyway**: Migrations de banco de dados versionadas\n- **DDD**: Domain-Driven Design para arquitetura limpa\n- **Docker**: Containerização com multi-stage build (~110MB)\n\n## 📚 Documentação Detalhada\n\nPara entender os conceitos e padrões utilizados neste projeto, consulte a documentação técnica:\n\n- **[Domain-Driven Design (DDD)](docs/01-domain-driven-design.md)** - Entenda como organizamos o domínio\n- **[Arquitetura Limpa](docs/02-clean-architecture.md)** - Conheça a estrutura de camadas\n- **[Event Dispatcher](docs/03-event-dispatcher.md)** - Aprenda sobre eventos de domínio\n- **[Graceful Shutdown](docs/04-graceful-shutdown.md)** - Veja como implementamos shutdown controlado\n- **[RESTful API com Gin](docs/05-restful-api-gin.md)** - Domine o framework Gin\n- **[Swagger / OpenAPI](docs/06-swagger-documentation.md)** - Documentação interativa da API\n- **[Prometheus Monitoring](docs/07-prometheus-monitoring.md)** - Golden Signals e métricas de negócio\n- **[Docker \u0026 Deployment](docs/08-docker-deployment.md)** - Multi-stage build e containerização\n- **[Flyway Migrations](docs/09-flyway-migrations.md)** - Gerenciamento profissional de migrations\n- **[Prometheus Queries (PromQL)](docs/10-prometheus-queries.md)** - Guia completo de queries para métricas\n- **[Releases Automáticos](docs/12-automated-releases.md)** - Sistema de releases, tags e CHANGELOG automáticos\n- **[Database PostgreSQL](db/README.md)** - Schema SQL, migrations e persistência\n\n📖 [**Ver toda a documentação →**](docs/README.md)\n\n## 🚀 Releases e Versionamento\n\nEste projeto utiliza **Semantic Versioning** e **Conventional Commits** para releases automáticos:\n\n- ✅ **Versioning automático** baseado em commits\n- ✅ **CHANGELOG.md** gerado automaticamente\n- ✅ **Tags Git** criadas automaticamente\n- ✅ **GitHub Releases** publicados automaticamente\n\n### Como funciona\n\nAo fazer push para `main` com commits no formato [Conventional Commits](https://www.conventionalcommits.org/pt-br/):\n\n```bash\n# Nova funcionalidade (minor version)\ngit commit -m \"feat: adiciona autenticação JWT\"\n\n# Correção de bug (patch version)\ngit commit -m \"fix: corrige timeout em requisições\"\n\n# Breaking change (major version)\ngit commit -m \"feat!: redesenha API v2\"\n```\n\nO sistema automaticamente:\n1. Analisa os commits\n2. Determina a nova versão\n3. Atualiza o CHANGELOG.md\n4. Cria tag Git\n5. Publica release no GitHub\n\n📖 [**Guia completo de releases →**](docs/12-automated-releases.md)\n\n## 🤝 Contribuindo\n\nContribuições são bem-vindas! Sinta-se à vontade para abrir issues ou pull requests.\n\n## 📝 Licença\n\nEste projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.\n\n---\n\n**Baseado no artigo de [William Koller](https://williamkoller.substack.com)**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftech-preta%2Falderaan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftech-preta%2Falderaan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftech-preta%2Falderaan/lists"}