{"id":15132537,"url":"https://github.com/lvleo21/fastapi-taskfy","last_synced_at":"2026-01-28T09:36:10.088Z","repository":{"id":256077490,"uuid":"851317291","full_name":"lvleo21/fastapi-taskfy","owner":"lvleo21","description":"É uma API para gerenciar uma lista de tarefas (to-do list), permitindo a criação, leitura, atualização e exclusão de tarefas (operações CRUD). Este projeto foi desenvolvido como parte de um desafio técnico, com o objetivo de demonstrar minhas habilidades de desenvolvimento backend utilizando Python e o framework FastAPI.","archived":false,"fork":false,"pushed_at":"2024-09-08T19:20:50.000Z","size":236,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-07T14:03:41.774Z","etag":null,"topics":["alembic","api-rest","docker","fastapi","flyio","postgresql","python","redis","sqlalchemy"],"latest_commit_sha":null,"homepage":"https://fastapi-taskfy.fly.dev/","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/lvleo21.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}},"created_at":"2024-09-02T21:36:58.000Z","updated_at":"2024-09-08T19:22:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"e3553a86-74b5-440e-b90e-0b9abd2824a3","html_url":"https://github.com/lvleo21/fastapi-taskfy","commit_stats":null,"previous_names":["lvleo21/fastapi-taskfy"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/lvleo21/fastapi-taskfy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lvleo21%2Ffastapi-taskfy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lvleo21%2Ffastapi-taskfy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lvleo21%2Ffastapi-taskfy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lvleo21%2Ffastapi-taskfy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lvleo21","download_url":"https://codeload.github.com/lvleo21/fastapi-taskfy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lvleo21%2Ffastapi-taskfy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28843933,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T07:39:25.367Z","status":"ssl_error","status_checked_at":"2026-01-28T07:39:24.487Z","response_time":57,"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":["alembic","api-rest","docker","fastapi","flyio","postgresql","python","redis","sqlalchemy"],"created_at":"2024-09-26T04:20:37.046Z","updated_at":"2026-01-28T09:36:10.070Z","avatar_url":"https://github.com/lvleo21.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  Taskfy\n\u003c/h1\u003e\n\n![Taskfy](.github/assets/taskfy.png)\n\n\u003cp align=\"center\"\u003e\n  Taskfy é a solução perfeita para quem busca organizar tarefas e aumentar a produtividade de forma prática e eficiente. A API foi desenvolvida utilizando\n  FastAPI em conjunto com Docker, PostgreSQL, Redis e está hospedada no Fly.io.\n  Para acessar a aplicação basta acessar o link \u003ca href=\"https://fastapi-taskfy.fly.dev/\" target=\"_blank\"\u003eclicando aqui\u003c/a\u003e.\n\u003c/p\u003e\n\n## Como o projeto foi organizado e executado?\n\n\u003cp\u003e\n  O projeto foi estruturado com base em um desáfio técnico e tinha como objetivo\n  avaliar as habilidades de desenvolvimento em backend com Python, utilizando o framework FastAPI. Para isso, é necessário a implementação de um microserviço para gerenciar uma lista de tarefas (to-do list), com as operações CRUD (Create, Read, Update, Delete) e alguns requisitos adicionais.\n\u003c/p\u003e\n\n### Requisitos\n- [X] CRUD das tarefas\n- [X] Persistência de dados com PostgreSQL\n- [X] Otimização de consultas\n- [X] Implementação de estrutura no padrão de microserviço\n- [X] Implementação de testes unitários para as funcionalidades\n- [X] Implementação de testes de integração\n- [X] Implementação de cache de resultados com Redis\n- [X] Utilizar Docker para containerizar o projeto\n- [ ] Configurar o projeto para rodar em um ambiente Kubernetes\n- [X] Realizar o deploy do microserviço em alguma infraestrutura\n\n### Github Projects\n\n![Taskfy](.github/assets/github-projects.png)\n\n\u003cp\u003e\n  A partir dos requisitos, utilizei o *Github Projects* para gerenciar as tarefas do\n  projeto. Este projeto, seguiu a metodologia do kanban e incialmente as tarefas foram\n  inseridas no backlogo. Após a finalização do planejamento e estratégia de desenvolimento,\n  as tarefas foram alteradas para ready. Com decorrer dos dias, as tarefas foram sendo alteradas\n  de status a medida que eram executada (in progress, in review e por fim done).\n\u003c/p\u003e\n\n## Quais foram as tecnologias utilizadas?\n\n- **FastAPI:** Um framework web rápido para construir APIs em Python, focado em alto desempenho e simplicidade.\n- **Redis:** Um banco de dados em memória, rápido e escalável, usado para cache, filas e armazenamento de dados.\n- **Docker:** Plataforma para criar, implantar e gerenciar contêineres, permitindo isolamento e portabilidade de aplicações.\n- **Alembic:** Uma ferramenta de migração de banco de dados usada com SQLAlchemy, que facilita o versionamento de esquemas.\n- **SQLAlchemy:** Um ORM (Object Relational Mapper) para Python que facilita a interação com bancos de dados relacionais.\n- **PostgreSQL:** Um banco de dados relacional open-source, conhecido por sua robustez, extensibilidade e suporte a operações complexas e dados estruturados.\n- **Fly.io:** Uma plataforma de hospedagem de aplicativos que permite o deploy em servidores globais próximos aos usuários.\n\n## Como rodar o projeto localmente?\n\n### Com Docker\n\n#### Pré-requisito\n\n- Docker / Docker compose\n- Github\n\n#### Passos\n\u003cp\u003ePara rodar o projeto com docker siga as seguintes passos:\u003c/p\u003e\n\n1 - Clonar o repositório\n```bash\ngit clone git@github.com:lvleo21/fastapi-taskfy.git\n```\n\n2 - Abrir o repositório clonado em sua IDE de preferência\n```bash\ncode fastapi-taskfy/ # 'code' para vscode\n```\n\n3 - No terminal da IDE (ou em algum de sua preferência e acessando a pasta do repositório) rodar comando do makefile para buildar o projeto\n\n\n```bash\n# Com Makefile\nmake up-taskfy\n\n# Sem Makefile\ndocker compose -f docker-compose.yml up -d --build --force-recreate --remove-orphans\n```\n\n4 - Em seu navegador acessar o `localhost`\n```bash\nhttp://localhost:8000/\n```\n\n### Sem Docker\n\n#### Pré-requisito\n\n- Github\n- Python 3.9+\n- Pip\n- PostgreSQL\n- Redis\n- Virtualenv (venv)\n\n#### Passos\n\u003cp\u003ePara rodar o projeto com docker siga as seguintes passos:\u003c/p\u003e\n\n1 - Clonar o repositório\n```bash\ngit clone git@github.com:lvleo21/fastapi-taskfy.git\n```\n\n2 - Abrir o repositório clonado em sua IDE de preferência\n```bash\ncode fastapi-taskfy/ # 'code' para vscode\n```\n\n3 - No terminal da IDE (ou em algum de sua preferência e acessando a pasta do repositório) rodar comando para criar e ativar o ambiente virtual \n\n\"***venv** é uma ferramenta do Python para criar ambientes virtuais, permitindo isolar dependências e pacotes específicos para projetos diferentes. Um ambiente virtual ajuda a evitar conflitos entre bibliotecas e facilita a gestão das versões dos pacotes usados no projeto.*\"\n\n```bash\npython3 -m venv venv\nsource venv/bin/activate\n```\n\n4 - Agora é necessário instalar todas as dependências do projeto que estão registradas\nno arquivo de `requirements.txt`\n\n```bash\npip install --upgrade pip\npip install -r requirements.txt --no-cache-dir\n```\n\n**Atenção:** antes de seguir para os próximos passos certifique-se que seu `postgres` e `redis` estejam rodando corretamente.\n\n5 - Faça uma cópia do arquivo `.env-example` e renomei para `.env`\n\n6 - Ainda em `.env` preencha o `DATABASE_URL` com as informações correspondentes\n\n```text\nDATABASE_URL=postgresql://\u003cSEU_USUARIO\u003e:\u003cSUA_SENHA\u003e@\u003cSEU_HOST\u003e:\u003cSUA_PORTA\u003e/\u003cSEU_DATABASE\u003e\n```\n\n7 - Para executar aplicação **Com Makefile**:\n\n```bash\n# Rodar as migrações\nmake migrate-taskfy\n\n# Executar aplicação\nmake start-taskfy\n```\n\n8 - Para executar aplicação **Sem Makefile**:\n\n```bash\n# Executa as migrações do banco de dados\nalembic upgrade head\n\n# Inicia a aplicação\nuvicorn --host localhost --port 8000 main:app --reload\n```\n\n9 - Aplicação estará disponível em `localhost:8000`\n```bash\nhttp://localhost:8000/\n```\n\n**Extra:** Para rodar os testes execute **pytest**\n```bash\npytest\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flvleo21%2Ffastapi-taskfy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flvleo21%2Ffastapi-taskfy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flvleo21%2Ffastapi-taskfy/lists"}