Skip to content

Pink-Hat-Hacker/allergen-ai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. Contact

About The Project

Product Name Screen Shot

As someone who forgets to ask if a dish has any allergens in it (peanuts and tree nuts in my case), I thought building this helpful tool might be cool. Take a picture of your food, upload it, execute the API calls, and voila ... food, ingredients, and potential allergens are detected for you. No need for social interaction!

P.S. This is for educational and experimental purposes only. Do not use this as official. Consult your food provider or official nutritional information

(back to top)

Built With

Front End

  • React.js
  • javascript
  • radix-ui

Back End

  • firebase-url
  • gh-pages
  • logmeal.es

(back to top)

Getting Started

Prerequisites

npm i

  • radix-ui
  • radix-ui/themes
  • radix-ui/icons
  • firebase
  • gh-pages --save-dev

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Get a free API Key at LogMeal.es and create database with Firebase DB
  2. Clone the repo
    git clone https://github.com/your_username_/Project-Name.git
  3. Install NPM packages
    npm install
  4. Enter your API in src/config.js
    export const configuration = {
        LOGMEAL_API_KEY: 'YOUR LOGMEAL API KEY',
        LOGMEAL_API_URL: 'https://api.logmeal.es',
        LOGMEAL_API_DISHPATH: '/v2/image/segmentation/complete/v1.0?language=eng',
        LOGMEAL_API_NUTRIPATH: '/v2/nutrition/recipe/ingredients/v1.0?language=eng'
    };
    
    export const firebaseConfig = {
        apiKey: "YOUR FIREBASE KEY",
        authDomain: "YOURPROJECT.firebaseapp.com",
        databaseURL: "YOUR DATABASE URL",
        projectId: "YOUR PROJECT ID",
        storageBucket: "",
        messagingSenderId: "",
        appId: "",
        measurementId: ""
    }
    
    

Roadmap

  • Add Error Alerts
  • Host on Vercel
  • Multi-language Support
    • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Contact

PHH

(back to top)