Git Product home page Git Product logo

diabetes-food-database's Introduction

Diabetes Food Database

Food information for people with diabetes. Visit the website at https://dfdb.netlify.com/ and search for a food item.

Contributing

The infrastructure for this app is there, but the database itself is extremely lacking. Pull requests are welcome! Please look at modifying src/assets/database.json.

When adding a new food, please include the following properties:

  • name - The name of the food. Will be used for searching. Must be unique, singular (smoothie instead smoothies) and all lowercase (carrot instead of Carrot).
  • displayName - A prettier name of the food. If the name is sugar, the displayName might be Sugar (with capitalization).
  • alternateNames - An array of names people might also use when searching for this food. Should also be singular and all lowercase.
  • level - A number from 1 to 5.
    • 1 = Avoid - Diabetic people should stay away from this food.
    • 2 = Caution - This food can be eaten in moderation or under certain conditions.
    • 3 = Okay - Neutral. No significant positive or negative health effects.
    • 4 = Good - Food that is good for a diabetic person to eat.
    • 5 = Great - Foods at this level are among the healthiest options.
  • explanation - A reason why this food is or is not healthy.
  • suggestions - Actions to take regarding this food. Alternatives to this food if it is unhealthy.

Built with

License

MIT License

Copyright (c) 2022 Travis Horn

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

diabetes-food-database's People

Contributors

dependabot[bot] avatar nicostar26 avatar nurintaaan avatar patcodefy avatar pkaz avatar rudrakshk avatar ryudanuer avatar suniti13 avatar tekuor avatar travishorn avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

diabetes-food-database's Issues

Why not use mongodb for data storage?

As you're storing the items as JSON could be good to add a Mongodb in the backend in order to store the data. Be simple enough to dump that JSON and allow users to start inputting foods?

The database needs more food items

I've started with about 30 food items in the database, which is laughable when you consider all the different foods out there. But you have to start somewhere.

See src/database.json

I am looking for contributors to add food items to the database. Each item should have (if applicable):

  • name - The name of the food. Will be used for searching. Must be unique, singular (smoothie
    instead smoothies) and all lowercase (carrot instead of Carrot).
  • displayName - A prettier name of the food. If the name is sugar, the displayName might be
    Sugar (with capitalization).
  • alternateNames - An array of names people might also use when searching for this food. Should
    also be singular and all lowercase.
  • level - A number from 1 to 5.
    • 1 = Avoid - Diabetic people should stay away from this food.
    • 2 = Caution - This food can be eaten in moderation or under certain conditions.
    • 3 = Okay - Neutral. No significant positive or negative health effects.
    • 4 = Good - Food that is good for a diabetic person to eat.
    • 5 = Great - Foods at this level are among the healthiest options.
  • explanation - A reason why this food is or is not healthy.
  • suggestions - Actions to take regarding this food. Alternatives to this food if it is
    unhealthy.
  • ingredients - An array of items that make up this food. Items in this array must match the
    name of another food in the database.

When your pull request is accepted, your changes will automatically be live on https://dfdb.netlify.com

Thanks in advance to anyone who helps fill in this database.

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.