https://github.com/renatorrocha/fuel-price-api
https://github.com/renatorrocha/fuel-price-api
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/renatorrocha/fuel-price-api
- Owner: renatorrocha
- Created: 2024-10-12T00:51:09.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-11-13T14:02:36.000Z (6 months ago)
- Last Synced: 2025-01-28T22:27:12.547Z (4 months ago)
- Language: TypeScript
- Size: 98.6 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fuel Price API
## Descrição
Este é um projeto de API para gerenciamento de preços de combustíveis, construído com o framework [NestJS](https://nestjs.com). A API permite o upload de arquivos CSV contendo dados de preços de combustíveis e fornece endpoints para consultar esses dados.
## Configuração do Projeto
Para configurar o projeto, siga os passos abaixo:
### Pré-requisitos
- Node.js (versão 14 ou superior)
- pnpm (gerenciador de pacotes)
### Instalação
```bash
$ pnpm install
```
## Compilar e Executar o Projeto
```bash
# Modo de desenvolvimento
$ pnpm run start
# Modo de observação
$ pnpm run start:dev
# Modo de produção
$ pnpm run start:prod
```
## Endpoints da API
### Upload de CSV
- **POST** `/fuel/upload-csv`
- Permite o upload de um arquivo CSV contendo dados de preços de combustíveis.
### Consultar Preços
- **GET** `/fuel/prices`
- Retorna todos os preços de combustíveis disponíveis.
### Buscar Preços
- **GET** `/fuel/search`
- Permite buscar preços de combustíveis filtrando por região e produto.
- Parâmetros:
- `region`: Região do combustível.
- `product`: Tipo de combustível.