📦 Catálogo de Produtos📦

Introdução

O projeto tem como objetivo descrever os produtos, considerando suas características e especificações detalhadas. As informações são obtidas por meio de pesquisas em diversos sites de e-commerce, permitindo uma visão ampla e comparativa de cada item. Isso facilita a organização, comparação e apresentação dos produtos de forma clara e padronizada.

🎯 Para que Serve um Catálogo de Produtos?

Benefício	Descrição
📁 Organização e Apresentação	Exibe os produtos de forma estruturada, facilitando a busca e a comparação.
📑 Informações Detalhadas	Inclui descrição completa, fotos, preço e especificações técnicas dos produtos.
🛒 Facilitação da Compra	Auxilia os compradores a encontrarem o que procuram e tomarem decisões informadas.
💼 Ferramenta de Vendas	Ajuda os vendedores a apresentarem seus produtos de forma profissional e atrativa.

🏆 Equipe Responsável

👤Integrantes do Projeto

• Bruno Coelho Lopes
• Carlos Eduardo Lima
• Isabella Ramos Carvalho
• João Pedro Pereira Porfírio

💻 Tecnologias

Este projeto foi construído usando várias tecnologias chaves para garantir performance, segurança e facilidade de uso:

• Python 3.12: Escolhido por sua simplicidade e poderosas capacidades de programação. A versão 3.13 é a mais recente, oferecendo melhorias significativas em eficiência e recursos linguísticos.
• FastAPI: Uma moderna e rápida (altas performances) web framework para Python, que é ideal para a construção de APIs.

✨ Configuração do ambiente local

Confirme se o Python 3.12 está instalado em sua máquina.

Comandos via Linux 🐧.

Clone o projeto, acesse o diretório:

cd pc-catalogo

Crie o ambiente virtual para instalar as bibliotecas e trabalharmos com o projeto:

make build-venv

Uma vez criado o ambiente virtual do Python, você precisa ativá-lo:

./venv/bin/activate

Quaisquer comandos daqui para frente, iremos considerar que você está dentro do ambiente virtual (venv).

Instale as bibliotecas necessárias para o seu projeto. Execute os comandos:

# Instala os pacotes.
make requirements-dev

Comandos via Windows 🗔.

Este projeto foi desenvolvido utilizando o Python 3.12, confirme se o mesmo está instalado em sua máquina.

Clone o projeto, acesse o diretório:

# Clona o projeto.
cd pc-catalogo

Crie o ambiente virtual para instalar as bibliotecas e trabalharmos com o projeto:

# Cria o ambiente virtual.
python3.12 -m venv venv

Uma vez criado o ambiente virtual do Python, você precisa ativá-lo:

# Ativa o ambiente virtual.
venv\Scripts\activate

Quaisquer comandos daqui para frente, iremos considerar que você está dentro do ambiente virtual (venv).

Instale as bibliotecas necessárias para o seu projeto. Execute os comandos:

# Instala os pacotes.
pip install -r requirements.txt

Para novos commits, siga o padrão do https://commitlint.io/

▶️ Execução da API usando Docker

Configure o arquivo de env:

Crie o arquivo .env na pasta raiz do projeto com o seguinte conteúdo:

ENV=dev

ou execute o seguinte script na pasta raiz do projeto com o Git Bash:

./devtools/scripts/push-env devtools/dotenv.dev

Use o comando para subir a API:

uvicorn app.api_main:app --reload

▶️ Execução da API usando Docker-compose

Na raiz do projeto, execute o comando:

docker-compose -f devtools/docker-compose-catalogo.yml up --build

API: http://localhost:8000

▶️ Execução SonarQuve para análise do projeto

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

SonarQube: http://localhost:9000 (usuário padrão: admin, senha: admin)

Análise com SonarQuve

1. Gere e exporte o token do SonarQube

Após acessar o SonarQube:

• Vá em "My Account" > "Security".

• Gere um novo token (ex: catalogo).

• Em outro terminal execute o seguinte comando para executar o Sonar-scanner

Windows

set SONAR_TOKEN=<seu_token_aqui>

set SONAR_HOST_URL=http://localhost:9000

sonar-scanner -Dsonar.login=%SONAR_TOKEN% -Dsonar.host.url=%SONAR_HOST_URL%

Linux

export SONAR_TOKEN=<seu_token_aqui>

SONAR_HOST_URL=http://localhost:9000 pysonar-scanner

Isso irá enviar os dados da sua aplicação para análise no SonarQube.

Contribuições e Atualizações

O projeto está aberto a contribuições e atualizações da comunidade. O processo para contribuições é o seguinte:

• Pull Requests: Contribuições devem ser submetidas como pull requests.
• Code Review: Cada pull request passará por um code review detalhado pela equipe. Isso garante que o código esteja alinhado com os padrões de qualidade e funcionamento do projeto.
• Incorporação de Mudanças: Após a aprovação no code review, as mudanças serão integradas ao código principal.

📖 Recursos úteis

• Conventional Commits

👍 Merge Requests

• Fluxo de desenvolvimento e entrega contínua documentado no Kanban.