🚚 pc-frete

📦 Projeto de Frete para E-commerce

Este projeto representa o módulo de frete de um sistema de e-commerce. Ele simula a lógica envolvida no cálculo, exibição e gerenciamento do frete de produtos em uma loja virtual.

🎯 Objetivo

Desenvolver um módulo independente e reutilizável para lidar com o frete de pedidos online, de forma flexível e integrada a diferentes plataformas.

👥 Participantes

• Maria Cecília
• Guilherme Gabriel
• Victor Hugo
• Felipe Andrade

💻 Tecnologias

Este projeto utiliza tecnologias modernas para garantir performance, segurança e escalabilidade:

• Python 3.12
• FastAPI: Framework moderno e rápido para construção de APIs.
• Uvicorn: Servidor ASGI leve e rápido.
• Make: Automatização de tarefas.
• SonarQube: Ferramenta de análise estática de código.
• Outras dependências listadas em requirements.

---

🚀 Clonando o Repositório

git clone https://github.com/projeto-carreira-luizalabs-2025/pc-frete
cd pc-frete

---

🛠️ Configuração do Ambiente Local (Linux)

1. Crie o ambiente virtual:

   make build-venv

2. Ative o ambiente virtual:

   source venv/bin/activate

3. Instale as dependências:

   make requirements-dev

---

✨ Lint e Formatação de Código

Para validar o lint:

make lint

---

▶️ Execução da API

1. Copie o arquivo .env:

   cp devtools/dotenv.dev .env

2. Rode o servidor:

   make run-dev

3. Acesse a documentação:

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

---

🐳 SonarQube com Docker

1. Suba o SonarQube:

   sudo docker-compose -f ./devtools/docker/docker-compose-sonar.yml up

2. Acesse o SonarQube em: http://localhost:9000 com login admin e senha admin:

3. Crie um token de autenticação no seu perfil. http://localhost:9000/account/security

4. Copie o token gerado e adicione no arquivo sonar-project.properties:

   sonar.login=<seu_token_aqui>

5. Instale o SonarScanner CLI manualmente:

   wget https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-5.0.1.3006-linux.zip
   unzip sonar-scanner-cli-5.0.1.3006-linux.zip
   export PATH="$PWD/sonar-scanner-5.0.1.3006-linux/bin:$PATH"

6. Execute a análise:

   sonar-scanner

---

🐳 Build e Execução via Docker

Build da imagem

sudo docker build -f ./devtools/docker/Dockerfile -t pc/frete .

Rodar a aplicação

sudo docker run --rm -p 8000:8000 pc/frete

---

💡 Recursos Úteis

• Conventional Commits

---

👍 Contribuições

• Contribuições devem ser feitas via Pull Request.
• Todo PR passará por Code Review pela equipe.
• Após aprovação, as mudanças serão integradas ao repositório principal.