{"id":19195530,"url":"https://github.com/renanholler/backend-shopper","last_synced_at":"2026-04-11T09:07:15.733Z","repository":{"id":255194345,"uuid":"848476323","full_name":"renanholler/backend-shopper","owner":"renanholler","description":"Este repositório é o backend de uma aplicação desenvolvida para gerenciar a leitura individualizada de consumo de água e gás utilizando inteligência artificial para análise de imagens. ","archived":false,"fork":false,"pushed_at":"2024-08-30T23:02:09.000Z","size":173,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-23T04:41:27.501Z","etag":null,"topics":["docker-compose","eslint","jest","mongodb","mongoose","nodejs","prettier","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/renanholler.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-27T20:40:05.000Z","updated_at":"2024-08-30T23:02:12.000Z","dependencies_parsed_at":"2024-08-28T14:50:49.287Z","dependency_job_id":"f78a2ce1-894a-4db3-8a6b-427b703aef5d","html_url":"https://github.com/renanholler/backend-shopper","commit_stats":null,"previous_names":["renanholler/backend-shopper"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/renanholler/backend-shopper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renanholler%2Fbackend-shopper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renanholler%2Fbackend-shopper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renanholler%2Fbackend-shopper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renanholler%2Fbackend-shopper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/renanholler","download_url":"https://codeload.github.com/renanholler/backend-shopper/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renanholler%2Fbackend-shopper/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266590780,"owners_count":23952999,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker-compose","eslint","jest","mongodb","mongoose","nodejs","prettier","typescript"],"created_at":"2024-11-09T12:10:33.194Z","updated_at":"2026-04-11T09:07:10.713Z","avatar_url":"https://github.com/renanholler.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Backend Shopper\n\nA aplicação está totalmente dockerizada e integra-se com a API do Google Gemini para análise das imagens enviadas.\n\n## Tecnologias Utilizadas\n\n- **Node.js**: Ambiente de execução para JavaScript no backend.\n- **TypeScript**: Utilizado para tipagem estática e organização do código.\n- **Express**: Framework web para criação de APIs RESTful.\n- **MongoDB**: Banco de dados NoSQL utilizado para armazenar as leituras.\n- **Docker e Docker Compose**: Ferramentas de containerização para fácil configuração e execução da aplicação.\n- **Google Generative AI**: Utilizado para análise e upload de imagens.\n\n## Estrutura do Projeto\n\n- `middlewares/`: Middlewares para validação de dados e processamento de requisições.\n- `routes/`: Define as rotas da aplicação (`upload`, `confirm`, `list`).\n- `services/`: Serviços para integração com o Google Gemini para análise e upload de imagens.\n- `useCases/`: Implementações dos casos de uso principais, como confirmação e listagem de medidas.\n- `models/`: Modelos de dados, incluindo o esquema de `Measure`.\n- `utils/`: Utilitários para manipulação de dados e tratamento de erros.\n\n## Instalação\n\n1. **Clone o repositório**:\n   ```bash\n   git clone https://github.com/renanholler/backend-shopper.git\n   ```\n2. **Navegue para o diretório do projeto**:\n   ```bash\n   cd backend-shopper\n   ```\n3. **Instale as dependências**:\n   ```bash\n   npm install\n   ```\n\n## Configuração\n\n1. **Crie um arquivo `.env`** na raiz do projeto com as seguintes variáveis de ambiente:\n   ```env\n   MONGO_URL=mongodb://mongo:27017/shopper\n   PORT=80\n   GEMINI_API_KEY=sua_chave_api\n   ```\n   Substitua `sua_chave_api` pela chave da API do Google Gemini.\n\n## Execução com Docker\n\n1. **Construir e iniciar os containers**:\n   ```bash\n   docker compose up --build\n   ```\n   Isso iniciará o MongoDB e o backend na porta 80.\n\n## Endpoints da API\n\n### 1. **POST /upload**\n\nRecebe uma imagem em base64, consulta o Google Gemini e retorna a medida lida.\n\n- **Request Body**:\n  ```json\n  {\n    \"image\": \"base64\",\n    \"customer_code\": \"string\",\n    \"measure_datetime\": \"datetime\",\n    \"measure_type\": \"WATER\" ou \"GAS\"\n  }\n  ```\n- **Response Body**:\n  - **200 OK**:\n  ```json\n  {\n    \"image_url\": \"string\",\n    \"measure_value\": integer,\n    \"measure_uuid\": \"string\"\n  }\n  ```\n  - **400 INVALID_DATA**: Erro nos dados fornecidos.\n  - **409 DOUBLE_REPORT**: Leitura do mês já realizada.\n\n### 2. **PATCH /confirm**\n\nConfirma ou corrige o valor lido pelo LLM.\n\n- **Request Body**:\n  ```json\n  {\n    \"measure_uuid\": \"string\",\n    \"confirmed_value\": integer\n  }\n  ```\n- **Response Body**:\n  - **200 OK**:\n  ```json\n  {\n    \"success\": true\n  }\n  ```\n  - **400 INVALID_DATA**: Dados inválidos.\n  - **404 MEASURE_NOT_FOUND**: Leitura não encontrada.\n  - **409 CONFIRMATION_DUPLICATE**: Leitura já confirmada.\n\n### 3. **GET /:customer_code/list**\n\nLista as medidas realizadas por um determinado cliente.\n\n- **Query Parameter**: `measure_type` opcional (`WATER` ou `GAS`).\n- **Response Body**:\n  - **200 OK**:\n  ```json\n  {\n    \"customer_code\": \"string\",\n    \"measures\": [\n      {\n        \"measure_uuid\": \"string\",\n        \"measure_datetime\": \"datetime\",\n        \"measure_type\": \"string\",\n        \"has_confirmed\": boolean,\n        \"image_url\": \"string\"\n      }\n    ]\n  }\n  ```\n  - **400 INVALID_TYPE**: Tipo de medição inválido.\n  - **404 MEASURES_NOT_FOUND**: Nenhuma leitura encontrada.\n\n## Testes\n\nO projeto inclui uma suite de testes unitários que validam as principais funcionalidades dos middlewares, modelos, serviços e utilitários.\n\n- **Para rodar os testes**, execute:\n  ```bash\n  npm test\n  ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenanholler%2Fbackend-shopper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frenanholler%2Fbackend-shopper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenanholler%2Fbackend-shopper/lists"}