README.md

Você no controle da sua dieta!

Sobre • Daily Diet API • Instalação • Tecnologias • Autor

Sobre

Projeto desenvolvido durante o desafio do módulo II do bootcamp Ignite da Rocketseat cujo objetivo foi colocar em prática todo o conteúdo estudado durante o módulo.

Daily Diet API

A API proposta nesse desafio tem como cliente um aplicativo criado em React Native o qual pode ser visto no link abaixo:

O propósito desse repositório é conter o código da API dessa aplicação, colocando todo o conteúdo aprendido durante o módulo em prática e cumprir as regras abaixo para a API:

Regras da aplicação

• Deve ser possível criar um usuário.

• Deve ser possível identificar o usuário entre as requisições.

• Deve ser possível registrar uma refeição feita, com as seguintes informações:

  ⚠ As refeições devem ser relacionadas a um usuário.

  • Nome.
  • Descrição.
  • Data e Hora.
  • Está dentro ou não da dieta.

• Deve ser possível editar uma refeição, podendo alterar todos os dados acima.

• Deve ser possível apagar uma refeição.

• Deve ser possível listar todas as refeições de um usuário.

• Deve ser possível visualizar uma única refeição.

• 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

• O usuário só pode visualizar, editar e apagar as refeições o qual ele criou.

As requisições para testar a API estão disponíveis no botão abaixo:

Instalação

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disso é bom ter um editor para trabalhar com o código como VSCode.

🎲 Rodando o Back End (servidor)

# Clone este repositório
$ git clone git@github.com:MrRioja/daily-diet-api.git

# Acesse a pasta do projeto no terminal/cmd
$ cd daily-diet-api

# Instale as dependências
$ npm install
# Caso prefira usar o Yarn execute o comando abaixo
$ yarn

# Execute a aplicação em modo de desenvolvimento
$ npm run dev
# Caso prefira usar o Yarn execute o comando abaixo
$ yarn dev

# O servidor iniciará na porta 3333 ou na porta definida no arquivo .env na variável PORT - acesse <http://localhost:3333>

Tecnologias

Autor

Luiz Rioja

Backend Developer