{"id":27314306,"url":"https://github.com/borriguel/quiz","last_synced_at":"2026-04-09T23:55:16.821Z","repository":{"id":253479293,"uuid":"842663903","full_name":"Borriguel/quiz","owner":"Borriguel","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-12T23:07:40.000Z","size":96,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T07:54:35.726Z","etag":null,"topics":["docker","docker-compose","dockerfile","java-21","postgresql","spring-boot-3","spring-data-jpa","spring-security-jwt","swagger-ui"],"latest_commit_sha":null,"homepage":"","language":"Java","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/Borriguel.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,"zenodo":null}},"created_at":"2024-08-14T20:06:48.000Z","updated_at":"2024-09-12T23:07:44.000Z","dependencies_parsed_at":"2024-08-17T02:28:42.802Z","dependency_job_id":"ad07ed92-6b75-4b09-b5fe-6488dafbf904","html_url":"https://github.com/Borriguel/quiz","commit_stats":null,"previous_names":["borriguel/quiz"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Borriguel/quiz","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Borriguel%2Fquiz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Borriguel%2Fquiz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Borriguel%2Fquiz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Borriguel%2Fquiz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Borriguel","download_url":"https://codeload.github.com/Borriguel/quiz/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Borriguel%2Fquiz/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267687607,"owners_count":24127959,"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-07-29T02:00:12.549Z","response_time":2574,"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":["docker","docker-compose","dockerfile","java-21","postgresql","spring-boot-3","spring-data-jpa","spring-security-jwt","swagger-ui"],"created_at":"2025-04-12T07:54:34.175Z","updated_at":"2026-04-09T23:55:16.798Z","avatar_url":"https://github.com/Borriguel.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003cp align=\"center\"\u003e Quiz API\u003c/p\u003e\n\nEste projeto é uma API construída com **Java, Spring Boot, PostgreSQL, Docker e Docker Compose.**\n\nA API permite a criação de quizzes, perguntas e alternativas, além de permitir a resolução de quizzes por usuários\nautenticados.\n\n## Tabela de conteúdo\n\n- [Pré-requisitos](#pré-requisitos)\n- [Configuração](#configuração)\n- [Iniciando a aplicação](#iniciando-a-aplicação)\n- [Estrutura do Projeto](#estrutura-do-projeto)\n- [Parando a aplicação](#parando-a-aplicação)\n- [Solução de problemas](#solução-de-problemas)\n- [Rotas da API](#rotas-da-api)\n- [Contribuição](#contribuição)\n\n## Pré-requisitos\n\n- Docker\n- Docker compose\n\n## Configuração\n\nClone o repositório:\n\n```bash\ngit clone https://github.com/Borriguel/quiz.git\n```\n\nCrie um arquivo `.env` na raíz do projeto com as seguintes variáveis:\n\n````\nDB_USERNAME= seu_usuario_db\nDB_PASSWORD= sua_senha_db\nJWT_SECRET= seu_segredo_jwt\nJWT_EXPIRATION_MS= tempo_expiracao_em_ms\n````\n\nExemplo:\n\n````\nDB_USERNAME= admin\nDB_PASSWORD= 123\nJWT_SECRET= 71596D68536E50624B2B4728443F41387635732F785B6B585567624E61\nJWT_EXPIRATION_MS= 86400000\n````\n\n# Iniciando a aplicação\n\n1. Construa e inicie os contêineres:\n\n```bash\ndocker compose up\n```\n\n2. A API estará disponível em \u003clocalhost:8080\u003e e para acessar o swagger e fazer requisições através do\n   navegador \u003clocalhost:8080/swagger-ui/index.html\u003e\n3. O banco de dados PostgreSQL estará acessível na porta ``5432``\n\n## Estrutura do Projeto\n\n- A aplicação Java roda no contêiner `app`\n- O banco de dados PostgreSQL roda no contêiner `db`\n- Os contêineres estão na mesma rede `quiz-net`\n- Os dados do PostgreSQL são persistidos no volume `banco-dados`\n\n## Parando a aplicação\n\nPara parar a aplicação, use:\n\n```bash\ndocker compose down\n```\n\nPara parar a aplicação e remover os volumes (isso apagará todos os dados do banco):\n\n```bash\ndocker compose down -v\n```\n\n## Solução de problemas\n\nSe encontrar problemas, verifique:\n\n- Se todas as variáveis de ambiente no arquivo `.env` estão corretamente definidas\n- Se as portas 8080 e 5432 não estão sendo usadas por outros processos em sua máquina\n- Se o Docker e Docker Compose estão instalados corretamente em sua máquina. Você pode verificar isso executando:\n\n```bash\ndocker --version\n```\n\n```bash\ndocker compose --version\n```\n\n## Rotas da API\n\n### Auth\n\n#### Registro de Usuário\n\n```\nPOST /api/v1/auth/registro\n\n{\n  \"nome\": \"Exemplo Usuario\",\n  \"username\": \"usuario\"\n  \"email\": \"usuario@exemplo.com\",\n  \"senha\": \"senhaSuperSegura123\"\n}\n```\n\n#### Login de Usuário\n\n```\nPOST /api/v1/auth/login\n{\n  \"username\": \"usuario\"\n  \"senha\": \"senhaSuperSegura123\"\n}\n```\n\n### Usuário\n\n#### Buscar usuário pelo ID\n\n```\nGET /api/v1/usuario/{id}\n```\n\n#### Buscar todos usuários paginados\n\n```\nGET /api/v1/usuario\n```\n\n#### Excluir usuário pelo ID\n\n```\nDELETE /api/v1/usuario/{id}\n```\n\n#### Atualizar usuário pelo ID\n\n```\nPUT /api/v1/usuario/{id}\n{\n  \"nome\": \"Nome Novo\",\n  \"username\": \"username_novo\",\n  \"email\": \"email.novo@email.com\",\n  \"senha\": \"novasenha123\",\n  \"dataNascimento\": \"1990-01-01\"\n}\n```\n\n### Quiz\n\n#### Criar quiz\n\n```\nPOST /api/v1/quiz\n{\n  \"titulo\": \"Quiz de Programação\",\n  \"descricao\": \"Teste seus conhecimentos em Java e Spring\"\n}\n```\n\n#### Buscar quiz por ID\n\n```\nGET /api/v1/quiz/{id}\n```\n\n#### Buscar todos os quizzes paginados\n\n```\nGET /api/v1/quiz\n```\n\n#### Excluir quiz por ID\n\n```\nDELETE /api/v1/quiz/{id}\n```\n\n#### Atualizar quiz por ID\n\n```\nPUT /api/v1/quiz/{id}\n{\n  \"titulo\": \"Quiz de Programação Avançada\",\n  \"descricao\": \"Teste seus conhecimentos em Design Patterns e Arquitetura de Software\"\n}\n```\n\n### Pergunta\n\n#### Adicionar pergunta a um quiz\n\n```\nPOST /api/v1/pergunta/quiz/{id}\n{\n  \"enunciado\": \"Qual é a principal característica da programação orientada a objetos?\",\n  \"dificuldade\": \"MEDIO\"\n}\n```\n\n#### Deletar pergunta por ID\n\n```\nDELETE /api/v1/pergunta/{id}\n```\n\n#### Buscar pergunta por ID\n\n```\nGET /api/v1/pergunta/{id}\n```\n\n#### Buscar todas as perguntas de um quiz:\n\n```\nGET /api/v1/pergunta/quiz/{id}\n```\n\n#### Atualizar pergunta por ID\n\n```\nPUT /api/v1/pergunta/{id}\n{\n  \"enunciado\": \"Qual é o princípio fundamental da programação orientada a objetos?\",\n  \"dificuldade\": \"DIFICIL\"\n}\n```\n\n### Alternativa\n\n#### Adicionar alternativa a uma pergunta\n\n```\nPOST /api/v1/alternativa/pergunta/{id}\n{\n  \"proposicao\": \"Encapsulamento\",\n  \"correta\": true\n}\n```\n\n#### Atualizar alternativa por ID\n\n```\nPUT /api/v1/alternativa/{id}\n{\n  \"proposicao\": \"Herança\",\n  \"correta\": false\n}\n```\n\n#### Deletar alternativa por ID\n\n```\nDELETE /api/v1/alternativa/{id}\n```\n\n### Resposta\n\n#### Salvar resposta\n\n```\nPOST /api/v1/respostas\n{\n  \"idQuiz\": 1,\n  \"idPergunta\": 2,\n  \"idAlternativa\": 3\n}\n```\n\n#### Buscar resposta por ID\n\n```\nGET /api/v1/respostas/{id}\n```\n\n#### Deletar resposta por ID\n\n```\nDELETE /api/v1/respostas/{id}\n```\n\n#### Deletar todas as resposta de um quiz de um usuário específico\n\n```\nDELETE /api/v1/respostas/tudo/{id}?idUsuario={idUsuario}\n```\n\n### Resultado\n\n#### Calcular o resultado do quiz de um usuário\n\n```\nGET /api/v1/resultado/quiz/1?usuarioId={id}\n```\n\n## Contribuição\n\nContribuições são bem-vindas! Se você deseja contribuir, por favor siga os passos abaixo:\n\n1. Faça um fork deste repositório.\n2. Crie uma nova branch: ``git checkout -b feature/nova-feature``\n3. Faça suas alterações e commit: ``git commit -m 'Adiciona nova feature'``\n4. Envie para o repositório remoto: ``git push origin feature/nova-feature``\n5. Abra um Pull Request explicando suas alterações.\n\nDesenvolvido com 💜 por Rodolpho Henrique","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fborriguel%2Fquiz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fborriguel%2Fquiz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fborriguel%2Fquiz/lists"}