Título do projeto

Repositorio modelo para desenvolvimento de projetos da disciplina de Engenharia de Dados do curso de Engenharia de Software da UNISATC.

Desenho de Arquitetura

Coloque uma imagem do seu projeto, como no exemplo abaixo:

Pré-requisitos e ferramentas utilizadas

• Linguagem: Python 3.11+
• Framework web: FastAPI
• Servidor ASGI: Uvicorn
• Qualidade de código: pre-commit (ruff, black, isort, flake8, mypy)
• Container: Docker
• Orquestração local: Docker Compose
• Documentação: MkDocs + mkdocstrings + mkdocs-material

Dar exemplos

Instalação

1. Clonar o repositório

git clone https://github.com/jlsilva01/projeto-ed-satc.git
cd projeto-ed-satc

2. Instalar dependências & pre-commit

uv venv
source .venv/bin/activate
uv sync

# instalar hooks do pre-commit
uv run pre-commit install

3. Executar localmente

uv run uvicorn app.main:app --reload

Acesse a API em http://localhost:8000 e a documentação automática em:

• Swagger UI: http://localhost:8000/docs
• ReDoc: http://localhost:8000/redoc

Documentação (MkDocs)

Toda a documentação está em docs/:

uv run mkdocs build
uv run mkdocs serve

Acesse o site em http://127.0.0.1:8000.

Para publicar o site estático:

uv run mkdocs gh-deploy

Colaboração

1. Abra uma issue para discutir sua feature ou bug.

2. Crie um branch:

   git checkout -b feature/nome-da-sua-feature

3. Faça suas alterações e commit seguindo o Conventional Commits.

4. Envie um pull request para main.

5. Aguarde revisão e merge.

Versão

Fale sobre a versão e o controle de versões para o projeto.

Autores

Mencione todos aqueles que ajudaram a levantar o projeto desde o seu início

• Aluno 1 - Trabalho Inicial - (https://github.com/linkParaPerfil)
• Aluno 2 - Documentação - https://github.com/linkParaPerfil

Licença

Este projeto está sob a licença (sua licença) - veja o arquivo LICENSE para detalhes.

Referências

Cite aqui todas as referências utilizadas neste projeto, pode ser outros repositórios, livros, artigos de internet etc.