{"id":45056376,"url":"https://github.com/pedro-git-projects/carteirinha-digital-api","last_synced_at":"2026-02-19T09:43:20.061Z","repository":{"id":216164257,"uuid":"735609366","full_name":"pedro-git-projects/carteirinha-digital-api","owner":"pedro-git-projects","description":null,"archived":false,"fork":false,"pushed_at":"2024-01-08T18:13:09.000Z","size":44,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-01-09T19:46:28.592Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/pedro-git-projects.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}},"created_at":"2023-12-25T14:31:21.000Z","updated_at":"2024-01-08T18:02:34.000Z","dependencies_parsed_at":"2024-01-08T19:54:11.151Z","dependency_job_id":null,"html_url":"https://github.com/pedro-git-projects/carteirinha-digital-api","commit_stats":null,"previous_names":["pedro-git-projects/carteirinha-digital-api"],"tags_count":0,"template":null,"template_full_name":null,"purl":"pkg:github/pedro-git-projects/carteirinha-digital-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedro-git-projects%2Fcarteirinha-digital-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedro-git-projects%2Fcarteirinha-digital-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedro-git-projects%2Fcarteirinha-digital-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedro-git-projects%2Fcarteirinha-digital-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pedro-git-projects","download_url":"https://codeload.github.com/pedro-git-projects/carteirinha-digital-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedro-git-projects%2Fcarteirinha-digital-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29609525,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-19T06:47:36.664Z","status":"ssl_error","status_checked_at":"2026-02-19T06:45:47.551Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2026-02-19T09:43:19.178Z","updated_at":"2026-02-19T09:43:20.052Z","avatar_url":"https://github.com/pedro-git-projects.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Carteirinha Digital - API\n\nEste repositório contém a implementação da API em Golang para um aplicativo de controle de entrada de alunos, conhecido como \"Carteirinha Digital\". O aplicativo utiliza o framework Gin para a construção da API e a biblioteca go-qrcode para a geração de códigos QR. Além disso, o banco de dados utilizado é o PostgreSQL, gerenciado em um container Docker, e as migrações são realizadas através de arquivos .sql utilizando a ferramenta Golang Migrate.\n\n## Configuração do Ambiente\n\n### Requisitos\n\nCertifique-se de ter os seguintes requisitos instalados em sua máquina:\n\n- Golang\n- Docker\n- Docker Compose\n- GNU Make\n\n### Configuração do Banco de Dados\n\nO banco de dados PostgreSQL pode ser iniciado em um container Docker utilizando o seguinte comando:\n\n```bash\ndocker-compose up -d\n```\n\nIsso iniciará o PostgreSQL em um container configurado conforme as especificações do arquivo `docker-compose.yml`.\n\n### Migrações\n\nAs migrações do banco de dados são gerenciadas através da ferramenta Golang Migrate. Certifique-se de ter a ferramenta instalada em sua máquina. As migrações estão localizadas no diretório `migrations/`. Para executar as migrações, utilize o seguinte comando:\n\n```bash\nmigrate -path migrations/ -database \"postgres://username:password@localhost:5432/database_name?sslmode=disable\" up\n```\n\nSubstitua `username`, `password`, e `database_name` com as credenciais apropriadas.\n\n## Endpoints da API\n\n### Autenticação\n\nA autenticação é necessária para acessar os seguintes endpoints. O token de acesso deve ser enviado no cabeçalho da requisição.\n\n- **GET /auth/qr-code**: Gera um código QR para autenticação.\n- **POST /auth/record-attendance**: Registra a entrada de um aluno na escola.\n\n#### Autenticação de Usuários\n\n- **POST /auth/students/signin**: Autenticação de estudantes.\n- **POST /auth/parents/signin**: Autenticação de responsáveis.\n- **POST /auth/staff/signin**: Autenticação de funcionários.\n\n### Cadastro de Usuários\n\n- **POST /parent-student**: Criação de vínculo entre responsável e estudante.\n- **POST /students**: Cadastro de estudantes.\n- **POST /parents**: Cadastro de responsáveis.\n- **POST /staff**: Cadastro de funcionários.\n\n### Saúde da API\n\n- **GET /**: Verifica a saúde da API.\n\n## Como Executar\n\n1. Clone o repositório:\n\n```bash\ngit clone https://github.com/seu-usuario/carteirinha-digital-api.git\ncd carteirinha-digital-api\n```\n\n2. Configure o ambiente e inicie o banco de dados:\n\n```bash\ndocker-compose up -d\n```\n\n3. Execute as migrações:\n\n```bash\nmake migrate-up\n```\n\n4. Inicie a API:\n\n```bash\nmake run\n```\n\nA API estará disponível em `http://localhost:8080`.\n\nEsteja ciente de fornecer as credenciais corretas para o banco de dados e ajustar conforme necessário antes de iniciar a aplicação.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpedro-git-projects%2Fcarteirinha-digital-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpedro-git-projects%2Fcarteirinha-digital-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpedro-git-projects%2Fcarteirinha-digital-api/lists"}