Reconhecedor de marcas de cerveja

Este repositório contém duas APIs que compõem o sistema de reconhecimento de marcas de cerveja, implementadas em diferentes tecnologias.

Estrutura do Projeto

A estrutura do projeto é organizada da seguinte maneira:

• ProjetoVaiNaWeb/
  • api1_nest/ (Diretório da API 1 - Nest.js)
    • src/ (Código fonte da API 1)
    • package.json (Dependências da API 1)
    • nest-cli.json (Configurações do Nest CLI)
    • tsconfig.json (Configuração do TypeScript)
    • Outros arquivos e pastas
  • api2_python/ (Diretório da API 2 - Python)
    • app/ (Código fonte da API 2)
    • pyproject.toml (Dependências da API 2)
    • poetry.lock (Lock file do Poetry)
    • Outros arquivos e pastas
  • docker-compose.yml (Arquivo de configuração do Docker Compose)

Tecnologias Utilizadas

API 1 - Nest.js

• Repositório dedicado aqui
• Framework: Nest.js
• Linguagem: TypeScript
• Banco de Dados: SQLite3

API 2 - Python

• Repositório dedicado aqui
• Framework: FastAPI
• Linguagem: Python
• OCR: Tesseract OCR
• Gerenciador de Pacotes: Poetry

Arquitetura

• A API 1 (Nest.js) recebe solicitações de upload de imagem e repassa para a API 2.
• A API 2 (Python) processa a imagem usando Tesseract OCR e retorna a marca identificada.

Como Rodar o Projeto

1. Clone o Repositório

   git clone --recurse-submodules https://github.com/JuniorD-Isael/ReconhecedorDeMarcaDeCerveja.git
   cd ReconhecedorDeMarcaDeCerveja

2. Instale o Docker e Docker Compose

   Certifique-se de que você tenha o Docker e Docker Compose instalados.

3. Suba as APIs com Docker Compose

   docker-compose up --build

4. Acesse as APIs

   • API 1: http://localhost:3000
   • API 2: http://localhost:8000

Como Usar a API de Reconhecimento de Marca de Cerveja

A API permite processar uma imagem de uma lata de cerveja, identificar e retornar o nome da marca. Você pode interagir com ela de três maneiras: usando Postman, Insomnia, ou via terminal com cURL.

1. Via Postman

• Método: POST
• URL: http://localhost:8000/process-image
• Body: form-data
  • Campo file: faça o upload da imagem

2. Via Insomnia

• Método: POST
• URL: http://localhost:8000/process-image
• Body: Multipart
  • Campo file: faça o upload da imagem

3. Via Terminal (Usando cURL)

Execute o seguinte comando, substituindo <caminho-para-a-imagem> pelo caminho da imagem que deseja processar:

curl -X POST "http://localhost:8000/process-image" -F "file=@<caminho-para-a-imagem>"

Resposta Esperada

A resposta será um JSON contendo o nome da marca detectada:

{
"filename": "nome_do_arquivo.png",
"brandName": "Nome da marca detectada",
"created_at": "2024-10-01T01:46:22.515Z",
"imagePath": "uploads/nome_do_arquivo.png",
"id": 6
}

Como Ver Todos os Registros Salvos no Banco de Dados

Para visualizar todos os registros que já foram salvos no banco de dados, você pode acessar a seguinte rota:

• URL: http://localhost:3000/logs
• Método: GET

Essa rota retornará uma lista com todos os logs armazenados no banco de dados, incluindo detalhes como filename, brand, created_at, e imagePath.

Contribuição

Sinta-se à vontade para contribuir! Abra um issue ou um pull request.

Licença

Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.