2026_1_PI1_Grupo2_Lui

Equipe de Desenvolvimento

PI1 Grupo 02 — Professor Lui

Arthur Moreira	Arthur Carv.	Caio Vilas B.	Eduardo Ferr.	Enzo Menali	Flávia Melo
Gabriel Diniz	Guilherme Gus.	João Victor Pereira	Lucas Alves	Luisa Mel	Maria Clara
Nandjala	Paulo Vitor	Pedro H. A.	Pedro Lucas	Theo Medeiros	Vinícius Rib.

---

Fluxo de Trabalho (Git & GitHub)

1. Gestão de Branches

• Branch Principal: Nunca realize commits diretamente na main.
• Nomenclatura: Crie branches descritivas a partir da main (ex: feat/perfil-usuario, fix/erro-sensor-distancia).

2. Sincronização

Mantenha sua branch atualizada para evitar conflitos complexos no momento do merge:

# Atualize sua base local
git checkout main
git pull origin main

# Integre as mudanças à sua branch de trabalho
git checkout sua-branch
git merge main

3. Abertura de Pull Requests (PR)

Ao finalizar uma tarefa, abra um PR para a main. É obrigatório o preenchimento completo do template padrão, detalhando:

• O quê foi feito e o porquê.
• A Issue relacionada (ex: #42).
• Lista objetiva de alterações.
• Passo a passo de como testar (simulador ou físico), se aplicável.

4. Revisão por Pares (Code Review)

• Todo PR deve ser revisado por, no mínimo, um colega de equipe.
• O merge só está autorizado após a aprovação e a verificação do checklist de testes.

Padrões de Qualidade

• Commits Semânticos: Utilize o padrão Conventional Commits:
  • feat: Novas funcionalidades.
  • fix: Correção de bugs.
  • docs: Melhorias na documentação.
  • refactor: Alterações de código que não mudam o comportamento final.
• Granularidade: Faça commits pequenos e focados em uma única alteração lógica.
• Documentação: Mantenha os arquivos README e o status das Issues sempre atualizados.

---

Como executar a documentação localmente

1. Clone este repositório

git clone https://github.com/fcte-pi1/2026.1_PI1_Grupo2_Lui.git

2. Pré-requisitos

Linux (Ubuntu/Debian)

• Certifique-se de ter o make, python3, pip e venv instalados:

sudo apt update
sudo apt install -y make python3 python3-pip python3-venv

Windows

• Instale o Git for Windows
• Instale o Chocolatey (executando o terminal como administrador), ou use o Makefile que instala automaticamente.
• Em seguida, instale o Make com:

choco install make

3. Construir e iniciar os serviços com Make

Após instalar os pré-requisitos, execute:

make setup
make run

O script irá:

• Criar o ambiente virtual
• Instalar dependências
• Iniciar o servidor local com MkDocs

4. Acesse a documentação no navegador

Abra o navegador e vá para:

http://127.0.0.1:8123

Como rodar a aplicação (backend + frontend)

Pela raiz do projeto, usando os atalhos do Makefile:

# Instalar dependências
make install-backend    # dependências Python do backend
make install-frontend   # dependências Node do frontend
make install-deps       # instala as duas de uma vez

# Rodar a aplicação
make run-backend        # API (FastAPI/uvicorn) em http://127.0.0.1:8000
make run-frontend       # dashboard (CRA) em http://localhost:3000

Rode o backend e o frontend em terminais separados. Use make help para ver todos os comandos disponíveis.

Como compilar o relatório em LaTeX

Pré-requisitos

Windows

Para compilar os arquivos .tex, instale:

• MiKTeX: https://miktex.org/download
• Strawberry Perl: https://strawberryperl.com/

O MiKTeX fornece o ambiente LaTeX, enquanto o Strawberry Perl é necessário para a execução de algumas ferramentas utilizadas durante a compilação.

Linux (Ubuntu/Debian)

Instale o TeX Live e o Perl pelos repositórios da distribuição:

sudo apt update
sudo apt install -y texlive-full perl

O TeX Live fornece o ambiente LaTeX completo e o Perl é utilizado por algumas ferramentas auxiliares durante a compilação.

Utilizando o VS Code

1. Instale a extensão LaTeX Workshop no Visual Studio Code.
2. Abra a pasta do projeto no VS Code.
3. Abra um arquivo .tex.
4. Utilize o atalho Ctrl + Alt + B para compilar o documento.
5. Utilize o atalho Ctrl + Alt + V para visualizar o PDF gerado.

Após a compilação, o PDF será gerado automaticamente na pasta do projeto.

Importante: O arquivo PDF gerado é apenas um artefato de compilação local e não deve ser commitado no repositório. Realize commits apenas dos arquivos-fonte (.tex, imagens, bibliografia e demais recursos necessários para a geração do relatório.