An open API service indexing awesome lists of open source software.

https://github.com/raphaelamonteiro/delta-tasks

Sistema de organização ágil baseado no modelo Kanban. Desenvolvido com boas práticas de Engenharia de Software.
https://github.com/raphaelamonteiro/delta-tasks

project-management python software-engineering

Last synced: about 10 hours ago
JSON representation

Sistema de organização ágil baseado no modelo Kanban. Desenvolvido com boas práticas de Engenharia de Software.

Awesome Lists containing this project

README

          

# 🔺Delta
Gerenciador de tarefas ágil baseado no modelo Kanban.


Escopo |
Diagrama |
Tecnologias |
Requisitos |
Estrutura |
Como rodar |
Comandos |
Créditos

---

## 📋 Escopo

🚧 Em desenvolvimento...

## 🖋️ Diagrama

Diagrama de entidade-relacionamento do banco de dados (gerado no [dbdiagram.io](https://dbdiagram.io) a partir de [`docs/diagrama.dbml`](docs/diagrama.dbml)):

![Diagrama do banco de dados Delta Tasks](docs/uml.png)

## 🛠️ Tecnologias

![Python](https://img.shields.io/badge/Python-D71313?style=for-the-badge&logo=python&logoColor=white)
![FastAPI](https://img.shields.io/badge/FastAPI-D71313?style=for-the-badge&logo=FASTAPI&logoColor=white)
![PostgreSQL](https://img.shields.io/badge/PostgreSQL-D71313?style=for-the-badge&logo=postgresql&logoColor=white)
![Docker](https://img.shields.io/badge/Docker-D71313?style=for-the-badge&logo=docker&logoColor=white)
![Git](https://img.shields.io/badge/Git-D71313?style=for-the-badge&logo=git&logoColor=white)

## 🔎 Requisitos

- Python 3.12+
- PostgreSQL (configurável via `.env` — veja `.env.example`)

## 📦 Estrutura do Repositório

🚧 Em desenvolvimento...

## ⚙️ Como rodar o projeto?

Há dois caminhos equivalentes. Use **poetry** se já o tem instalado; senão use **pip + venv**.

### 🐍 Opção A: pip + venv

```bash
python -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
pip install -r requirements.txt # runtime apenas
# ou, para desenvolver (inclui ruff, mypy, pytest, etc.):
pip install -r requirements-dev.txt

python run.py # sobe a API em http://127.0.0.1:8000 (reload)
```

### 📦 Opção B: Poetry

```bash
make install # poetry install
make dev # uvicorn com --reload
```

## 🖥️ Comandos úteis (Makefile)

| Comando | Descrição |
| ---------------------- | ------------------------------------------------- |
| `make dev` | Sobe a API com reload |
| `make test` | Roda os testes (pytest) |
| `make lint` | ruff check + bandit |
| `make format` | ruff format |
| `make typecheck` | mypy (modo estrito) |
| `make migrate` | Aplica as migrations (alembic upgrade head) |
| `make install-pip` | Instala dependências de runtime via pip |
| `make install-pip-dev` | Instala runtime + ferramentas de dev via pip |
| `make requirements` | Regera `requirements*.txt` a partir do poetry.lock |

> Os arquivos `requirements.txt` e `requirements-dev.txt` são **gerados** a partir do `poetry.lock`.
> Após alterar dependências no `pyproject.toml`, rode `make requirements` para mantê-los em sincronia.

## 👥 Créditos

| Nome | Perfil no GitHub |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Raphaela Monteiro | [![GitHub](https://img.shields.io/badge/GitHub-111217?style=flat-square&logo=github&logoColor=white)](https://github.com/raphaelamonteiro) |
| Julia Pereira | [![GitHub](https://img.shields.io/badge/GitHub-111217?style=flat-square&logo=github&logoColor=white)](https://github.com/juliasoares17) |
| Pedro Garcia | [![GitHub](https://img.shields.io/badge/GitHub-111217?style=flat-square&logo=github&logoColor=white)](https://github.com/pedro-fs-garcia) |