Git Product home page Git Product logo

daily-diet-api's Introduction

Daily Diet API

Esta é a API Daily Diet, um sistema de controle de dieta diária.

Regras da Aplicação

A API possui as seguintes regras e funcionalidades:

  • Criação de Usuário: É possível criar um usuário.
  • Identificação de Usuário: O usuário é identificado entre as requisições por meio do session_id.
  • Registro de Refeição: É possível registrar uma refeição com as seguintes informações:
    • Nome
    • Descrição
    • Data e Hora
    • Está dentro ou fora da dieta
    • As refeições são relacionadas ao usuário que as criou.
  • Edição de Refeição: É possível editar uma refeição, permitindo alterar todos os dados mencionados acima.
  • Exclusão de Refeição: É possível apagar uma refeição.
  • Listagem de Refeições: É possível listar todas as refeições de um usuário.
  • Visualização de Refeição: É possível visualizar os detalhes de uma única refeição.
  • Métricas do Usuário: É possível recuperar as métricas de um usuário, incluindo:
    • 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.
  • Restrições de Acesso: O usuário só pode visualizar, editar e apagar as refeições que ele criou.

Rotas da API

A API possui as seguintes rotas disponíveis:

  • POST /users: Cria um novo usuário.
  • POST /meals: Registra uma nova refeição.
  • PUT /meals/:id: Edita os dados de uma refeição existente.
  • DELETE /meals/:id: Apaga uma refeição.
  • GET /meals: Lista todas as refeições de um usuário.
  • GET /meals/:id: Retorna os detalhes de uma única refeição.
  • GET /metrics: Retorna as métricas do usuário.

Configuração

Siga as etapas abaixo para configurar e executar a API:

  1. Clone o repositório para sua máquina local:
git clone https://github.com/seu-usuario/daily-diet-api.git
  1. Navegue até o diretório do projeto:
cd dayly-diet-api
  1. Instale as dependências do projeto:
npm install
  1. Configure as variáveis de ambiente necessárias, como a conexão com o banco de dados e a porta.

  2. Rode as migrations do projeto para criar o banco de dados

npm run knex -- migrate:latest
  1. Execute o comando para iniciar a API:
npm run dev

daily-diet-api's People

Contributors

lucasadsr avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.