{"id":29629832,"url":"https://github.com/techabraao/flash-cards-rest-api","last_synced_at":"2025-12-30T22:07:00.599Z","repository":{"id":305248813,"uuid":"1019754595","full_name":"TechAbraao/flash-cards-rest-api","owner":"TechAbraao","description":"RESTful API for flashcard management, built with Python, Flask, SQLAlchemy, MySQL, and Docker.","archived":false,"fork":false,"pushed_at":"2025-07-19T00:18:57.000Z","size":4391,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-19T04:59:04.416Z","etag":null,"topics":["docker","flask","marshmallow","mysql","postman","python","sqlalchemy","unittest"],"latest_commit_sha":null,"homepage":"","language":"Python","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/TechAbraao.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":"2025-07-14T20:22:43.000Z","updated_at":"2025-07-19T00:19:01.000Z","dependencies_parsed_at":"2025-07-19T04:59:07.202Z","dependency_job_id":"18e9a1c3-ab05-47a8-a377-a26f162c79ad","html_url":"https://github.com/TechAbraao/flash-cards-rest-api","commit_stats":null,"previous_names":["techabraao/flash-cards-rest-api"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/TechAbraao/flash-cards-rest-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TechAbraao%2Fflash-cards-rest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TechAbraao%2Fflash-cards-rest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TechAbraao%2Fflash-cards-rest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TechAbraao%2Fflash-cards-rest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TechAbraao","download_url":"https://codeload.github.com/TechAbraao/flash-cards-rest-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TechAbraao%2Fflash-cards-rest-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266278383,"owners_count":23904041,"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","flask","marshmallow","mysql","postman","python","sqlalchemy","unittest"],"created_at":"2025-07-21T10:07:08.052Z","updated_at":"2025-12-30T22:07:00.554Z","avatar_url":"https://github.com/TechAbraao.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flash Cards REST API\n\n### Tecnologias\n\u003csection align=\"left\"\u003e\n    \u003cimg alt=\"Static Badge\" src=\"https://img.shields.io/badge/Python-grey?style=flat\u0026logo=Python\"\u003e\n    \u003cimg alt=\"Static Badge\" src=\"https://img.shields.io/badge/Unittest-grey?style=flat\u0026logo=Python\"\u003e\n    \u003cimg alt=\"Static Badge\" src=\"https://img.shields.io/badge/Marshmallow-grey?style=flat\u0026logo=Python\"\u003e\n    \u003cimg alt=\"Static Badge\" src=\"https://img.shields.io/badge/Flask-grey?style=flat\u0026logo=Flask\"\u003e\n    \u003cimg alt=\"Static Badge\" src=\"https://img.shields.io/badge/SQLALchemy-grey?style=flat\u0026logo=SQLAlchemy\"\u003e\n    \u003cimg alt=\"Static Badge\" src=\"https://img.shields.io/badge/Docker-grey?style=flat\u0026logo=Docker\"\u003e\n    \u003cimg alt=\"Static Badge\" src=\"https://img.shields.io/badge/PostgreSQL-grey?style=flat\u0026logo=PostgreSQL\"\u003e\n    \u003cimg alt=\"Static Badge\" src=\"https://img.shields.io/badge/PgAdmin-grey?style=flat\u0026logo=PostgreSQL\"\u003e\n    \u003cimg alt=\"Static Badge\" src=\"https://img.shields.io/badge/Postman-grey?style=flat\u0026logo=Postman\"\u003e\n\u003c/section\u003e\n\n### Funcionalidades\n- __Gerenciamento de Decks:__ criar, listar, atualizar, excluir e visualizar detalhes de decks de flashcards.\n- __Gerenciamento de Flashcards:__ criar flashcards, associá-los a decks, buscar aleatoriamente ou individualmente, atualizar e remover flashcards.\n\n## Instalação\n\n```bash\n# Clone o repositório já trazendo o submódulo templates\ngit clone --recurse-submodules https://github.com/TechAbraao/flash-cards-rest-api.git\n\n# Acesse o diretório do projeto\ncd flash-cards-rest-api\n\n# (Opcional) Se esqueceu do --recurse-submodules, inicialize o submódulo manualmente\ngit submodule update --init --recursive\n\n# Crie o ambiente virtual\npython3 -m venv .venv\n\n# Ative o ambiente virtual (Linux ou Mac)\nsource .venv/bin/activate\n\n# Ou, se estiver no Windows\n# .venv\\Scripts\\activate\n\n# Instale as dependências do projeto\npip install -r src/requirements.txt\n\n# Acesse a pasta de código-fonte\ncd src\n\n# Rode a aplicação Flask\nflask run\n```\n## Atualizando o submódulo templates (quando houver alterações)\n```bash\n# Acesse a pasta do submódulo\ncd src/app/templates\n\n# Busque as últimas alterações do repositório de templates\ngit pull origin main  # ou a branch correta\n\n# Volte para o repositório principal\ncd ../../../..\n\n# Adicione e commite a atualização do submódulo\ngit add src/app/templates\ngit commit -m \"Atualiza submódulo templates\"\ngit push origin main\n```\n\n## Contrato e Definições da API\n### Endpoints\n#### Decks\n\n| Método | URL                   | Descrição                      |\n| ------ | --------------------- | ------------------------------- |\n| GET   | `/api/decks`           | Listar todos os decks          |\n| POST  | `/api/decks`           | Criar um novo deck             |\n| GET   | `/api/decks/\u003cid\u003e`      | Obter detalhes de um deck      |\n| PUT   | `/api/decks/\u003cid\u003e`      | Atualizar informações de um deck |\n\n##### Exemplo de Payload para Decks\n\n```json\n{\n  \"title\": \"História - Revolução Francesa Atualizado\",\n  \"description\": \"Deck atualizado com mais flashcards sobre a Revolução Francesa.\",\n  \"tags\": [\"história\", \"revolução\", \"frança\"]\n}\n```\n\n#### Cards\n\n| Método | URL                                 | Descrição                           |\n| ------ | ----------------------------------- | ----------------------------------- |\n| POST  | `/api/decks/\u003cdeck_id\u003e/cards`        | Adicionar card ao deck              |\n| GET   | `/api/decks/\u003cdeck_id\u003e/cards`        | Buscar todos os cards de um deck    |\n| GET   | `/api/decks/\u003cdeck_id\u003e/cards/random` | Buscar card aleatório do deck       |\n| GET   | `/api/cards/\u003ccard_id\u003e`              | Buscar card específico              |\n| PUT   | `/api/cards/\u003ccard_id\u003e`              | Atualizar card específico           |\n| DELETE| `/api/cards/\u003ccard_id\u003e`              | Remover card                        |\n\n#### Exemplo de Payload para Cards\n\n```json\n{\n  \"question\": \"Quando ocorreu a Revolução Francesa?\",\n  \"answer\": \"Em 1789.\",\n  \"tags\": [\"história\", \"datas\", \"revolução\"]\n}\n```\n\n#### Formato das Respostas da API:\nTodas as respostas da API seguem o seguinte padrão:\n\n- Sucesso\n```json\n{\n  \"success\": true,\n  \"message\": \"Mensagem descritiva da operação\",\n  \"data\": { /* objeto ou lista retornada */ }\n}\n```\n\n- Erro\n```json\n{\n  \"success\": false,\n  \"message\": \"Mensagem de erro\",\n  \"error\": { /* objeto ou lista de erros */ }\n}\n```\n\u003e **Observações:**  \n\u003e - O campo `error` contém o objeto de erro ou lista de erros.  \n\u003e - O campo `message` descreve o resultado da operação ou o motivo do erro.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechabraao%2Fflash-cards-rest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftechabraao%2Fflash-cards-rest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechabraao%2Fflash-cards-rest-api/lists"}