To Do List API

Descrição • Pastas • Demonstração • Funcionalidades • Status • Como Rodar • Tecnologias • Desenvolvedor

Descrição do Projeto 📋

Esta é uma API desenvolvida com o Django Rest Framework, a qual funciona como uma lista de tarefas (to do list). Nesse viés, tal API possibilita a criação de tarefas com os seguintes campos: título, descrição, data de conclusão e status de conclusão. Além de criar, também é possível listar, atualizar e deletar tarefas.

Estrutura de Pastas 🗂️

• Raíz

  ├── config
  ├── to_do_list
     └── migrations
  ├ manage.py
  ├ README.md
  ├ requirements.txt
  

Na pasta raiz, há três arquivos principais:

• README.md: guia sobre os aspectos do projeto
• manage.py: script que auxilia na gestão da API
• requirements.txt: requisitos para rodar a aplicação

Ademais, há duas pastas, as quais estão organizadas do seguinte modo:

• config/: pasta do django project, responsável por organizar todos os arquivos de configuração do projeto;
• to_do_list/: pasta do django app, responsável por organizar os arquivos relacionados ao aplicativo das tarefas.

Demonstração da Aplicação 💻

Dados para a inclusão de uma tarefa - post

Listagem das tarefas - get /tarefas/

Funcionalidades ⚙️

• Criar tarefas com os campos:
  • Título
  • Data de Conclusão
  • Status da Tarefa
  • Descrição
• Manipular as tarefas criadas:
  • Listar todas
  • Listar por ID
  • Atualizar
  • Deletar

Status do Projeto 🔔

🚧 Em Aprimoramento 🚧

Como Rodar a Aplicação 🚀

Pré-requisitos 📦

Antes de começar, é preciso que você tenha as seguintes ferramentas instaladas em sua máquina:

Git, Python.

Além disso, é interessante que você tenha um editor para trabalhar com o código. Recomendo o uso do Pycharm ou do VSCode

Rodando a Aplicação ▶

# No terminal, clone este repositório:
git clone <https://github.com/VictorGM01/to_do_api>

# Acesse a pasta do projeto
cd to_do_api

# Crie e ative um ambiente virtual
python -m venv .venv
.venv\Scripts\activate

# Instale as dependências
pip install -r requirements.txt

# Defina as variáveis de ambiente
# Crie, na raíz do projeto, um arquivo chamado .env
# Neste arquivo, defina as seguintes variáveis:
SECRET_KEY="cole-sua-chave-aqui"
DEBUG="1"

# Realize as migrações
python manage.py migrate

# Crie um usuário admin
python manage.py createsuperuser

# Rode o servidor
python manage.py runserver

Rodando os Testes da API ✅

# Após seguir os passos anteriores, certifique-se de estar na raíz do projeto
cd to_do_api

# Para rodar todos os testes, execute:
python manage.py test

# Para rodar somente os testes das tarefas, execute:
python manage.py test to_do_list

# Para rodar um método em específico, execute:
python manage.py test to_do_list.tests.TestTarefas.digite_o_nome_do_metodo_aqui
# Ex.: python manage.py test to_do_list.tests.TestTarefas.test_deve_retornar_status_code_200_no_metodo_get

Tecnologias 🛠️

As seguintes ferramentas foram usadas na construção do projeto:

• Python
• Django
• Django Rest Framework
• SQLite
• Fly
• Jazzmin

Desenvolvedor

_{Victor G. Marques}

Feito com ❤️ por Victor Marques 🖥️🔬