Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alxdelira/service-shopper-iamges
Esta API foi projetada para fornecer uma solução robusta e integrada para a leitura automatizada de hidrômetros de água e gás
https://github.com/alxdelira/service-shopper-iamges
expressjs gemeni mongodb multer nodejs swagger typescript
Last synced: about 1 month ago
JSON representation
Esta API foi projetada para fornecer uma solução robusta e integrada para a leitura automatizada de hidrômetros de água e gás
- Host: GitHub
- URL: https://github.com/alxdelira/service-shopper-iamges
- Owner: Alxdelira
- License: mit
- Created: 2024-08-27T21:28:48.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-29T18:44:31.000Z (3 months ago)
- Last Synced: 2024-10-11T04:01:46.955Z (about 1 month ago)
- Topics: expressjs, gemeni, mongodb, multer, nodejs, swagger, typescript
- Language: TypeScript
- Homepage:
- Size: 364 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Micro Serviço de Leitura de Imagens
Modelo de uso do projeto
## 🔥 Features
- [x] Integração com o Google Gemini 🔥
- [x] Ler uma imagem e buscar os dados para salvar no banco
- [x] Listar todas as leituras por tipo e código do cliente
- [x] Confirmar a leitura com validações referentes ao mês
## 🛠️ Tecnologias
Este projeto foi desenvolvido com as seguintes tecnologias:
- `typescript`: [TypeScript on GitHub](https://github.com/microsoft/TypeScript)
- `cors`: [npm cors](https://www.npmjs.com/package/cors)
- `dotenv`: [dotenv on GitHub](https://github.com/motdotla/dotenv)
- `express`: [Express.js on GitHub](https://github.com/expressjs/express)
- `mongoose`: [Mongoose on GitHub](https://github.com/Automattic/mongoose)
- `mongoose-paginate-v2`: [npm mongoose-paginate-v2](https://www.npmjs.com/package/mongoose-paginate-v2)
- `tsup`: [tsup on NPM](https://www.npmjs.com/package/tsup)
- `Swagger`: [swagger-UI on GitHub](https://github.com/swagger-api/swagger-ui)
- `Mongo DB`: [MongoDB](https://www.mongodb.com/pt-br)
- `Multer`: [Express.Js - multer](https://github.com/expressjs/multer)
- `GeminiAI`: [Gemini-AI on docs](https://ai.google.dev/gemini-api/docs)
## 🚀 Como Rodar o Projeto
Você precisará do [Node.js](https://nodejs.org) instalado em seu computador para rodar este projeto.
```bash
git clone https://github.com/Alxdelira/service-shopper-iamges
cp .env.example .env # Necessario fazer a alteração do .env com suas configurações.
cd nome-da-pasta
npm install
npm run dist # No caso aqui efetua o biuld
#para Rodar Localmente use
npm run watch
```
## 👌 Siga o modelo do env.example use sua chave da API do GEMINI AI
```bash
PORT= "use a porta que desejar"
# URL do banco de dados MongoDB
DB_SHOPPER_URL=" Url do Banco de sua escolha ( usei MongoDB )"
# Variáveis de configuração do MongoDB para o container Docker
DB_SHOPPER_EXPOSE_PORT=" Aqui escolhi a porta padrão do Mongo"
DB_SHOPPER_USERNAME="USER"
DB_SHOPPER_PASSWORD="PASSWORD"
DB_SHOPPER_DATABASE=" Nome do Database"
LANG=en_US.UTF-8 # Configuração de idioma e fuso horário
TZ=America/Porto_Velho # Usando o horario da minha região
GEMINI_API_KEY="API_KEY" # Gerar a chave da API do GEMINI para usar
````
## 🤖 Uso em ambiente de desenvolvimento
🔧 Run the script
```bash
npm run watch
```
Rodando em modo de desenvolvimento local.
## 🛳️ Docker Compose 🐋
Com docker compose basta executar:
```bash
cp .env.example .env
docker compose up -d
```
> Faça o comando sem a opção `-d` caso queira travar o terminal e acompanhar o log da aplicação (E do banco)
## 🐐 Autor
| [
Alexandre Nogueira](https://github.com/Alxdelira) |
| :-----------------------------------------------------------------------------------------------------------------------------------------------: |
