{"id":15061687,"url":"https://github.com/evans-costa/consumeterai","last_synced_at":"2026-01-02T19:02:21.195Z","repository":{"id":255093331,"uuid":"848261436","full_name":"evans-costa/ConsumeterAI","owner":"evans-costa","description":"Um serviço que gerencia medição e leitura individualizada de consumo de água e gás usando a Gemini AI","archived":false,"fork":false,"pushed_at":"2024-09-16T13:43:28.000Z","size":452,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-22T02:14:56.325Z","etag":null,"topics":["ai","docker","fastify","gemini-api","nodejs","postgresql","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/evans-costa.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-27T12:45:39.000Z","updated_at":"2024-09-16T13:43:31.000Z","dependencies_parsed_at":"2024-08-28T00:29:29.251Z","dependency_job_id":"17f7f4db-5228-4ff3-9f00-3bf82735076c","html_url":"https://github.com/evans-costa/ConsumeterAI","commit_stats":null,"previous_names":["evans-costa/teste-dev-shopper","evans-costa/consumeterai"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evans-costa%2FConsumeterAI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evans-costa%2FConsumeterAI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evans-costa%2FConsumeterAI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evans-costa%2FConsumeterAI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/evans-costa","download_url":"https://codeload.github.com/evans-costa/ConsumeterAI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243723217,"owners_count":20337338,"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","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":["ai","docker","fastify","gemini-api","nodejs","postgresql","typescript"],"created_at":"2024-09-24T23:23:41.282Z","updated_at":"2026-01-02T19:02:21.142Z","avatar_url":"https://github.com/evans-costa.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cbr\u003e\n   Leitor de Consumo AI\n  \u003cbr\u003e\n\u003c/h1\u003e\n\u003ch4 align=\"center\"\u003eUm serviço que gerencia medição e leitura individualizada de consumo de água e gás, feito com \u003cb\u003eTypescript\u003c/b\u003e e \u003cb\u003eNode.js\u003c/b\u003e, usando o \u003cb\u003eGoogle Gemini AI\u003c/b\u003e\u003c/h4\u003e\n\n\u003cdiv align='center'\u003e\n\n![Typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge\u0026logo=typescript\u0026logoColor=white)\n![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge\u0026logo=node.js\u0026logoColor=white)\n![Fastify](https://img.shields.io/badge/fastify-%23000000.svg?style=for-the-badge\u0026logo=fastify\u0026logoColor=white)\n![Gemini](https://img.shields.io/badge/Google%20Gemini-8E75B2?style=for-the-badge\u0026logo=googlegemini\u0026logoColor=white)\n![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge\u0026logo=postgresql\u0026logoColor=white)\n![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge\u0026logo=docker\u0026logoColor=white)\n![Zod](https://img.shields.io/badge/zod-%233068b7.svg?style=for-the-badge\u0026logo=zod\u0026logoColor=white)\n![Swagger](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge\u0026logo=swagger\u0026logoColor=white)\n\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#recursos-principais\"\u003eRecursos principais\u003c/a\u003e •\n  \u003ca href=\"#como-usar\"\u003eComo usar\u003c/a\u003e •\n  \u003ca href=\"#melhorias\"\u003eMelhorias\u003c/a\u003e •\n  \u003ca href=\"#creditos\"\u003eCréditos\u003c/a\u003e •\n  \u003ca href=\"#todo\"\u003eTODO\u003c/a\u003e\n\u003c/p\u003e\n\n## Recursos principais\n\n- Faça o upload de uma imagem de um medidor de gás ou água\n- A IA irá ler a imagem e obter a medição, retornando o valor\n- A aplicação irá pedir a confirmação o valor dessa medição\n- Salva no banco de dados os dados da medição, com o seu tipo (água ou gás)\n- Lista todas as medições pelo código do consumidor\n\n## Como usar\n\nPara clonar essa aplicação, você precisará ter instalado na sua máquina o [Node.js](https://nodejs.org/en/download/) (que vem com o [npm](http://npmjs.com)) e o [Docker](https://www.docker.com/get-started/) com [Docker Compose](https://docs.docker.com/compose/install/).\n\n- Da sua linha de comando:\n\n  ```bash\n  # Clone este repositório\n  $ git clone https://github.com/evans-costa/teste-dev-shopper.git\n\n  # Vá para a pasta do repositório\n  $ cd teste-dev-shopper\n  ```\n\n- Renomeie o arquivo `.env.example` para `.env` e preencha com a API KEY do Gemini\n\n  ```env\n  NODE_ENV=development\n\n  POSTGRES_PORT=5432\n  POSTGRES_USER=local_user\n  POSTGRES_DB=local_db\n  POSTGRES_PASSWORD=local_password\n\n  DATABASE_URL=postgres://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:$POSTGRES_PORT/$POSTGRES_DB\n\n  GEMINI_API_KEY=\u003cYOUR-GEMINI-API-KEY\u003e\n  ```\n\n  \u003e **📌 Nota:** \u003c/br\u003e\n  \u003e Para gerar uma chave de API do Google Gemini, por favor, siga as instruções contidas [nesse link](https://ai.google.dev/gemini-api/docs/api-key?hl=pt-br).\n\n### Ambiente local\n\nPara rodar essa aplicação localmente, siga essas instruções:\n\n- Instale as dependências:\n  ```bash\n  # Instale as dependências\n  $ npm install\n  ```\n- Rode o seguinte comando:\n\n  ```bash\n  # Suba os serviços e o servidor\n  $ npm run dev:local\n  ```\n\n  Isto irá subir o contêiner com o banco de dados, rodar as migrações, fazer o seed de um usuário na tabela `customers` e subir o servidor no endereço `http://localhost:3000`\n\n### Ambiente conteinerizado\n\n- Alternativamente, você pode subir todos os serviços, tanto a aplicação Node e os serviços do banco de dados, em uma rede de contêineres Docker\n- Rode o seguinte comando:\n\n  ```bash\n  # Suba os serviços e o servidor\n  $ npm run services:up\n  ```\n\n  Isso irá subir o contêiner do PostgreSQL, o contêiner do Node e estabelecer a conexão entre eles, assim como instalar as dependências, rodar as migrações e fazer o seed de um usuário na tabela `customers`, além de rodar o servidor no endereço `http://localhost:3000`\n\n### Testando a API\n\n- Você agora pode testar a API da seguinte maneira:\n  - Use o `customer_code`: `33f02178-e1bd-466d-a9a6-fa3f56cacda1`, criado no momento do seed do banco de dados, para testar os endpoints.\n  - Acesse `http://localhost:3000/documentation`, onde todos os endpoints da aplicação estão expostos por meio da interface do `SwaggerUI`\n    **OU**\n  - No seu cliente API REST de preferência como [Insomnia](https://insomnia.rest/download), [Postman](https://www.postman.com/), [Hoppscotch](https://hoppscotch.io/)...\n\n## Melhorias\n\n- Uso de `conventional commits` aliado ao `Husky` e o pacote `commitlint` para automatizar os commits usando o comando `npm run commit`, assim, no momento do commit, as definições já são expostas na CLI;\n- Documentação com o uso do Swagger;\n- Separação de responsabilidades usando repositórios, controllers e services;\n- Tratamento de erros;\n- Scripts de linting garantindo qualidade e estilização do código;\n- Migrações e seed do banco de dados.\n\n## Créditos\n\nEsse como parte do desafio para a vaga de Desenvolvedor Full Stack da \u003ca href=\"https://landing.shopper.com.br/\" target=\"_blank\"\u003eShopper\u003c/a\u003e\n\n## TODO\n\n- [ ] Testes automatizados\n\n\u003e GitHub [@evans-costa](https://github.com/evans-costa) \u0026nbsp;\u0026middot;\u0026nbsp;\n\u003e LinkedIn [@evandro-souzac](https://www.linkedin.com/in/evandro-souzac/) \u0026nbsp;\u0026middot;\u0026nbsp;\n\u003e Site [@evandrocosta.dev.br](https://evandrocosta.dev.br)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevans-costa%2Fconsumeterai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fevans-costa%2Fconsumeterai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevans-costa%2Fconsumeterai/lists"}