https://github.com/mtlouzada/codevalueapi
https://github.com/mtlouzada/codevalueapi
api-restful
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mtlouzada/codevalueapi
- Owner: mtlouzada
- License: mit
- Created: 2024-03-14T19:13:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-30T20:06:36.000Z (over 1 year ago)
- Last Synced: 2024-12-30T20:30:27.625Z (over 1 year ago)
- Topics: api-restful
- Language: TypeScript
- Homepage:
- Size: 75.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# CodeValueAPI
Este repositório contém um projeto dividido em **backend** e **frontend**, com o objetivo de exibir informações sobre os salários mínimos de 2010 a 2024 e calcular a média dos salários entre 2018 e 2024. A solução é moderna, responsiva e utiliza tecnologias atuais como Vite, TypeScript, SASS e Node.js.
---
## Tecnologias Utilizadas
### Backend
- **Node.js**
- **Express**
- **TypeScript**
### Frontend
- **Vite**
- **React**
- **TypeScript**
- **SASS**
### O que Aprendi 💡
Neste projeto, aprendi a organizar o backend de forma modular, criando endpoints eficientes em uma API RESTful e integrando-a ao frontend. Foi uma experiência valiosa para entender o fluxo de dados entre as camadas e aplicar boas práticas de estruturação e manutenibilidade.
## Funcionalidades
### Backend
- API RESTful para gerenciamento de salários mínimos.
- Endpoints:
- `GET /api/salaries`: Retorna a lista de salários.
- `GET /api/salaries/average?start=2018&end=2024`: Retorna a média de salários no intervalo especificado.
### Frontend
- Interface responsiva para exibir a lista de salários.
- Exibição da média de salários entre 2018 e 2024.
- Estilização minimalista e centralizada com SASS.
---
## Configuração do Projeto
### Requisitos
- Node.js (v16 ou superior)
- NPM ou Yarn
### Passo a Passo
#### 1. Clonar o repositório
```bash
git clone
cd CodeValueAPI
```
#### 2. Configurar o Backend
```bash
cd backend
npm install
npx ts-node src/index.ts
```
O servidor será iniciado em `http://localhost:3000`.
#### 3. Configurar o Frontend
```bash
cd frontend
npm install
npm run dev
```
O frontend será iniciado em `http://localhost:5173`.
## Exemplos de Uso
### Requisições da API
- **Obter a lista de salários:**
```bash
curl http://localhost:3000/api/salaries
```
- **Calcular a média dos salários entre 2018 e 2024:**
```bash
curl "http://localhost:3000/api/salaries/average?start=2018&end=2024"
```
---