Repositorio modelo para desenvolvimento do projeto final da disciplina de Engenharia de Dados do curso de Engenharia de Software da UNISATC.
Coloque uma imagem do seu projeto, como no exemplo abaixo:
- 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
git clone https://github.com/jlsilva01/projeto-ed-satc.git
cd projeto-ed-satcuv venv
source .venv/bin/activate
uv sync
# instalar hooks do pre-commit
uv run pre-commit installuv run uvicorn app.main:app --reloadAcesse a API em http://localhost:8000 e a documentação automática em:
- Swagger UI:
http://localhost:8000/docs - ReDoc:
http://localhost:8000/redoc
Toda a documentação está em docs/:
uv run mkdocs build
uv run mkdocs serveAcesse o site em http://127.0.0.1:8000.
Para publicar o site estático:
uv run mkdocs gh-deploy-
Abra uma issue para discutir sua feature ou bug.
-
Crie um branch:
git checkout -b feature/nome-da-sua-feature
-
Faça suas alterações e commit seguindo o Conventional Commits.
-
Envie um pull request para
main. -
Aguarde revisão e merge.
Fale sobre a versão e o controle de versões para o projeto.
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
Este projeto está sob a licença (sua licença) - veja o arquivo LICENSE para detalhes.
Cite aqui todas as referências utilizadas neste projeto, pode ser outros repositórios, livros, artigos de internet etc.