Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leo-henrique/daily-diet-api
API rest para controle de dieta diária.
https://github.com/leo-henrique/daily-diet-api
e2e-tests fastify knex nodejs
Last synced: 9 days ago
JSON representation
API rest para controle de dieta diária.
- Host: GitHub
- URL: https://github.com/leo-henrique/daily-diet-api
- Owner: Leo-Henrique
- Created: 2023-12-21T21:05:28.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-23T19:16:44.000Z (about 1 year ago)
- Last Synced: 2024-11-09T03:42:44.807Z (2 months ago)
- Topics: e2e-tests, fastify, knex, nodejs
- Language: TypeScript
- Homepage:
- Size: 90.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Daily Diet
API rest para controle de dieta diária.
## Principais conceitos
- **Variáveis de ambiente** - armazenamento de dados sensíveis e diferentes para ambiente de teste, desenvolvimento e produção
- **Migrations** - estruturação e gerenciamento da estrutura do banco de dados de forma versionada e segura
- **API REST** - criação e estruturação de portas de entrada da aplicação através de rotas HTTP, seguindo o padrão REST
- **Cookies** - fragmento de dados para manter contexto entre requisições. Nesta aplicação, usado para identificar o usuário com uma simulação de autenticação
- **Testes E2E** - testes de ponta a ponta na aplicação, simulando toda interação do lado do cliente no servidor
## Principais tecnologias
- [TypeScript](https://www.typescriptlang.org/) - JavaScript com tipagem estática
- [Node.js](https://nodejs.org/) - interpretador do JavaScript em server-side
- [Fastify](https://fastify.dev/) - framework para construção do servidor
- [Knex.js](https://knexjs.org/) - SQL builder
- [Vitest](https://vitest.dev/) - framework de testes
## Requisitos de software
### Requisitos funcionais
- [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
- [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 criar um usuário
- [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 de refeições dentro da dieta
### Regras de negócio
- [x] Deve ser possível identificar o usuário entre as requisições
- [x] O usuário só pode visualizar, editar e apagar as refeições o qual ele criou
## Rode o projeto
Defina as variáveis de ambiente:
```bash
# ambiente dev
cp env.example .env
# ambiente de testes
cp env.test.example .env.test
```
Instale as dependências:
```bash
yarn
```
Crie o banco de dados (não necessita de banco de dados local caso esteja usando SQLite nas variáveis de ambiente):
```bash
yarn knex migrate:latest
```
Rode o projeto
```bash
# inicie o servidor
yarn dev
# rode os testes
yarn test
```