Giter VIP home page Giter VIP logo

quantified-api's Introduction

Quantified Api

Introduction

This was a joint project between Brandon Stewart and Aaron Hursh. This application is a RESTful API that provides data to a JavaScript/JQuery calorie tracking app, and was built in Express on Node.js using the Knex library to perform SQL queries. This project was completed over the course of two weeks.

Getting Started

First, download and install Node.js

Then do the following:

git clone [email protected]:boveus/quantified-api.git
cd quantified-api
npm install

To start the server

npm start

Food Endpoints:

GET /api/v1/foods - returns a JSON of all foods

GET /api/v1/foods/:id - returns a single food item matching the given ID

POST /api/v1/foods - create a new food using the following syntax:

{ food: { name: "Food Name", calories: "1234"} }

PATCH /api/v1/foods/:id - update a single food item matching the given ID, use the following syntax:

{ food: { name: "Name of food here", calories: "Calories here"} }

DELETE /api/v1/foods/:id - will delete the food with the id passed in.

Meal Endpoints:

GET /api/v1/meals - returns all meals with foods assigned to those meals.

GET /api/v1/meals/:meal_id/foods - returns the foods associated with the meal ID given.

POST /api/v1/meals/:meal_id/foods/:id - adds a new food to the specified meal.

DELETE /api/v1/meals/:meal_id/foods/:id - removes the selected food from the specified meal

Contributing

Clone this repo, submit a pull request, and tag @amhursh (Aaron) or @boveus (Brandon) in the PR.

Version

This is version 1 of the Quantified API

Authors

Aaron Hursh and Brandon Stewart

License

This project is licensed under the MIT License

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.