Code Monkey home page Code Monkey logo

micro-food-diary's Introduction

Micro Food API

A simple REST API for adding consumed food items to database. Keeps track of four pieces of information:

  1. A title
  2. A summary
  3. Calories
  4. Date & time consumed

Version

0.0.1

Captured Information

The captured information goes into the database and is used for calculating various bits of information, such as calories.

Title

The title referred to above is a simple way of referring to the meal consumed. Ideally it should be a single word. Examples includes:

  • "salmon-salad"
  • "cashews"
  • "cheddar-cheese"

Titles should be simple and concise so they can be easily remembered and used again later.

Summary

The summary is more detail and is generally used for ingredients. For example (following on from above):

  • "spinach, snow peas, red onion, green pepper, avocado"
  • "honey roasted cashews"
  • "cheddar cheese on water crackers"

The summary gives you a bit more detail, but should also be concise. The formatting isn't important at this point and the user is free to supply whatever text they like.

Calories

The calorific value of the meal consumed. This can be left out and will default to zero (0).

Date & Time

This is handled automatically by the client.

Todo List

API

  • User registration and management
  • Social aspects, such as sharing profiles
  • Meal weight in grams
  • Meal count - how many items did you consume?
  • Tie into the US food database for nutrient data
  • Automatic timer/ticker for sending emails at time interval

Client

  • Refine options
  • Full editing of food database

Database

  • Refine model structure
  • Get MySQL in place for a stronger engine
  • Gather food database

Author

Michael Crilly

micro-food-diary's People

Watchers

James Cloos avatar  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.