Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/renanfachin/rs_ignite_daily-diet-api
Desafio do módulo 2 do bootcamp de especialização em nodeJS da rocketseat.
https://github.com/renanfachin/rs_ignite_daily-diet-api
ignite ignite-nodejs ignite-rocketseat node-api nodeapi nodejs rocketseat typescript
Last synced: 19 days ago
JSON representation
Desafio do módulo 2 do bootcamp de especialização em nodeJS da rocketseat.
- Host: GitHub
- URL: https://github.com/renanfachin/rs_ignite_daily-diet-api
- Owner: RenanFachin
- Created: 2023-04-18T19:12:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-04-21T00:37:00.000Z (over 1 year ago)
- Last Synced: 2024-04-19T09:56:16.855Z (8 months ago)
- Topics: ignite, ignite-nodejs, ignite-rocketseat, node-api, nodeapi, nodejs, rocketseat, typescript
- Language: TypeScript
- Homepage:
- Size: 595 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
API REST com NodeJS
# DAILY DIET API
API desenvolvida para registras todas as refeições que um usuário fizer durante o seu dia.
Quando o usuário se registra, um cookie é criado e armazenado. Utilizamos esse cookie para validar o registro, adicionando-o na coluna "session_id" da tabela "users". Depois, usamos esse identificador para validar o usuário que está adicionando uma nova refeição, de modo que possamos adicionar o ID do usuário na tabela "meals".
Tópicos abordados: `ESModule`, `Typescript`, `ESLint`, `Banco de dados - Knex, migrations, querys`,`Variáveis de ambiente`,`Validação de dados - ZOD`, `Fastify - Plugins, cookies e prehandlers`, `Testes automatizados - Tipos de testes, vitest, supertest`, `Build do projeto - TSUP` e `Deploy da aplicação`
## Regras da aplicação
- [x] Deve ser possível criar um usuário
- [x] Deve ser possível identificar o usuário entre as requisições
- [x] Deve ser possível registrar uma refeição feita, com as seguintes informações:
- Nome
- Descrição
- Data e Hora
- Está dentro ou não da dieta
- [x] Deve ser possível editar uma refeição, podendo alterar todos os dados acima
- [x] Deve ser possível apagar uma refeição
- [x] Deve ser possível listar todas as refeições de um usuário
- [x] Deve ser possível visualizar uma única refeição
- [x] Deve ser possível recuperar as métricas de um usuário
- Quantidade total de refeições registradas
- Quantidade total de refeições dentro da dieta
- Quantidade total de refeições fora da dieta
- Melhor sequência por dia de refeições dentro da dieta
- [x] O usuário só pode visualizar, editar e apagar as refeições o qual ele criou
## Instalação
```bash
# Faça o clone do repotório
git clone [email protected]:RenanFachin/RS_IGNITE_daily-diet-API.git
# Instalar as dependências do projeto
npm install
# Executando o projeto no ambiente de desenvolvimento
npm run dev
# Rodar as migrations do projeto para criar o banco de dados
npm run knex -- migrate:latest
```
## Insomnia do projeto
[](https://insomnia.rest/run/?label=ignite-daily-diet-api-insomniaConfigs&uri=https%3A%2F%2Fraw.githubusercontent.com%2FRenanFachin%2FRS_IGNITE_daily-diet-API%2Fmain%2Fexport.json)
## Rotas
- Criar novo usuário
```bash
POST /users
```
- Criar novo registro de refeição
```bash
POST /meals
```
- Listar todas refeições registradas pelo usuário
```bash
GET /meals
```
- Listar uma refeição específica registrada pelo usuário
```bash
GET /meals/:${meal_id}
```
- Mostrar um resumo geral das refeições cadastradas pelo usuário (total de refeições, refeições dentro da dieta e refeições fora da dieta)
```bash
GET /meals/summary
```
- Deletar uma refeição cadastrada
```bash
DELETE /meals/:${meal_id}
```
- Editar uma refeição cadastrada
```bash
PUT /meals/:${meal_id}
```
## Testes automatizados e2e
- [x] Should be able to create a new account
- [x] Should be able to create a new meal
- [x] Should be able to list all meals
- [x] Should be able to get a specific meals
- [x] Should be able to get the summary meals
- [x] Should be able to delete a specific meal
- [x] Should be able to edit a meal
```bash
# Após a instalação do projeto e suas depêndencias:
npm run test
```