{"id":25919726,"url":"https://github.com/yuri-italo/votacao","last_synced_at":"2026-04-11T14:06:04.188Z","repository":{"id":280007939,"uuid":"940624178","full_name":"yuri-italo/votacao","owner":"yuri-italo","description":"API REST desenvolvida em Java com Spring Boot para gerenciar sessões de votação em cooperativas.","archived":false,"fork":false,"pushed_at":"2025-02-28T17:43:50.000Z","size":83,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-28T21:58:33.299Z","etag":null,"topics":["docker","docker-compose","flyway","java","junit","postgresql","spring-boot","swagger"],"latest_commit_sha":null,"homepage":"","language":"Java","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/yuri-italo.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-02-28T14:02:52.000Z","updated_at":"2025-02-28T17:43:53.000Z","dependencies_parsed_at":"2025-02-28T21:58:39.897Z","dependency_job_id":"dead7c7c-e8e7-4301-aec8-e93ec43a7bc9","html_url":"https://github.com/yuri-italo/votacao","commit_stats":null,"previous_names":["yuri-italo/votacao"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/yuri-italo/votacao","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuri-italo%2Fvotacao","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuri-italo%2Fvotacao/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuri-italo%2Fvotacao/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuri-italo%2Fvotacao/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yuri-italo","download_url":"https://codeload.github.com/yuri-italo/votacao/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuri-italo%2Fvotacao/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265728867,"owners_count":23818731,"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":["docker","docker-compose","flyway","java","junit","postgresql","spring-boot","swagger"],"created_at":"2025-03-03T15:15:55.057Z","updated_at":"2025-12-30T22:07:10.459Z","avatar_url":"https://github.com/yuri-italo.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sistema de Votação\n\n## Descrição\n\nAPI REST desenvolvida em Java utilizando Spring Boot, com foco na gestão de sessões de votação em cooperativas. A API permite o cadastro de pautas, abertura de sessões de votação, recepção de votos dos associados e contabilização dos resultados.\n\n---\n\n## Funcionalidades Principais\n\n- **Cadastro de Pautas**: Crie pautas para serem votadas pelos associados.\n- **Sessões de Votação**: Abra sessões de votação com um tempo personalizado ou use o padrão de 1 minuto.\n- **Registro de Votos**: Associe votos (\"Sim\" ou \"Não\") a pautas, garantindo que cada associado vote apenas uma vez por pauta.\n- **Resultados**: Consulte o resultado das votações.\n- **Validação de CPF**: Integração com serviço de validação de CPF para garantir que apenas associados válidos possam votar.\n\n---\n\n## Tecnologias Utilizadas\n\n- **Java 21**\n- **Spring Boot 3.4.3**\n- **Spring Data JPA**\n- **Flyway para migrações de banco de dados**\n- **PostgreSQL (Banco de dados)**\n- **Swagger para documentação da API**\n- **MapStruct para mapeamento de DTOs**\n- **Lombok para simplificação do código**\n- **JUnit e Spring Test para testes automatizados**\n- **Containerização (Docker e Docker Compose)**\n---\n\n## Como Executar o Projeto\n\n### Pré-requisitos\n\n- **Java 21**: Instale o JDK 21.\n- **Docker**: Instale o Docker e o Docker Compose (opcional, mas recomendado).\n- **Maven**: Instale o Maven ou use o Maven Wrapper (`mvnw`) incluído no projeto.\n\n---\n\n### 1. Clonando o Repositório\n\n```bash\ngit clone https://github.com/yuri-italo/votacao.git\ncd votacao\n```\n\n---\n\n### 2. Executando com Docker Compose (Recomendado)\n\nO Docker Compose facilita a execução da aplicação e do banco de dados PostgreSQL em containers.\n\n1. Certifique-se de que o Docker está instalado e em execução.\n2. Execute o seguinte comando na raiz do projeto:\n\n   ```bash\n   docker-compose up --build\n   ```\n\n3. A aplicação estará disponível em `http://localhost:8080`.\n\n---\n\n### 3. Executando Localmente (Sem Docker)\n\n1. Certifique-se de que o PostgreSQL está instalado e em execução.\n2. Configure as credenciais do banco de dados no arquivo `application.yml`.\n3. Execute o projeto com o Maven Wrapper:\n\n   ```bash\n   ./mvnw spring-boot:run\n   ```\n\n4. A aplicação estará disponível em `http://localhost:8080`.\n\n---\n\n### 4. Acessando a Documentação da API\n\nA API está documentada com Swagger (OpenAPI 3.1.0). Após iniciar a aplicação, acesse:\n\n```\nhttp://localhost:8080/swagger-ui/index.html\n```\n\nAqui você pode explorar todos os endpoints, testar requisições e ver exemplos de payloads.\n\n---\n\n### 5. Executando Testes Automatizados\n\nPara rodar os testes unitários e de integração, execute:\n\n```bash\n./mvnw test\n```\n\n---\n\n## Endpoints da API\n\nA API está organizada em torno dos seguintes recursos:\n\n### **1. Pautas**\n- **POST `/api/v1/pauta`**: Cria uma nova pauta.\n- **GET `/api/v1/pauta/{id}`**: Retorna os detalhes de uma pauta específica.\n- **DELETE `/api/v1/pauta/{id}`**: Remove uma pauta pelo seu ID.\n- **GET `/api/v1/resultado/{pautaId}`**: Retorna o resultado da votação de uma pauta.\n\n### **2. Sessões de Votação**\n- **POST `/api/v1/sessao`**: Abre uma nova sessão de votação para uma pauta.\n- **GET `/api/v1/sessao/{id}`**: Retorna os detalhes de uma sessão de votação.\n\n### **3. Votos**\n- **POST `/api/v1/voto`**: Registra o voto de um associado em uma pauta.\n\n### **4. Associados**\n- **POST `/api/v1/associado`**: Cadastra um novo associado.\n- **GET `/api/v1/associado/{id}`**: Retorna os detalhes de um associado.\n- **DELETE `/api/v1/associado/{id}`**: Remove um associado pelo seu ID.\n\n---\n\n## Exemplos de Uso\n\n### Criar uma Pauta\n**Requisição**:\n```bash\nPOST /api/v1/pauta\nContent-Type: application/json\n\n{\n  \"nome\": \"Nova Pauta\",\n  \"descricao\": \"Descrição da pauta\"\n}\n```\n\n**Resposta**:\n```json\n{\n  \"id\": 1,\n  \"nome\": \"Nova Pauta\",\n  \"descricao\": \"Descrição da pauta\"\n}\n```\n\n### Abrir uma Sessão de Votação\n**Requisição**:\n```bash\nPOST /api/v1/sessao\nContent-Type: application/json\n\n{\n  \"pautaId\": 1,\n  \"dataInicio\": \"2025-01-01T10:00:00Z\",\n  \"dataFim\": \"2025-01-01T11:00:00Z\"\n}\n```\n\n**Resposta**:\n```json\n{\n  \"id\": 1,\n  \"dataInicio\": \"2025-01-01T10:00:00Z\",\n  \"dataFim\": \"2025-01-01T11:00:00Z\",\n  \"status\": \"ABERTA\"\n}\n```\n\n### Registrar um Voto\n**Requisição**:\n```bash\nPOST /api/v1/voto\nContent-Type: application/json\n\n{\n  \"escolha\": \"SIM\",\n  \"pautaId\": 1,\n  \"associadoId\": 1\n}\n```\n\n**Resposta**:\n```json\n{\n  \"id\": 1,\n  \"pauta\": \"Nova Pauta\",\n  \"nomeAssociado\": \"João Silva\"\n}\n```\n\n---\n\n## Funcionalidades Adicionais\n\n- **Validação de CPF**: A API valida se o CPF do associado é válido antes de registrar o voto.\n- **Versionamento**: A API está versionada usando o padrão `/api/v1/...`.\n\n---","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuri-italo%2Fvotacao","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyuri-italo%2Fvotacao","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuri-italo%2Fvotacao/lists"}