superzackx / DevLunch

A simple API that gives you a recipe depending on what ingredients you have at home. Please star!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Archived due to inactivity

forthebadge

GitHub contributors GitHub top language GitHub issues GitHub closed issues GitHub pull requests GitHub closed pull requests Github Stars Github Forks

Information Support
A simple API that gives you a recipe depending on what ingredients you have at home. It will soon use alogrithms to decide what all can be made according to your pasty searches. Updates will be made weekly and new versions are coming up! support us by contributing and PLEASE star this repo. Can we reach 1k stars?

Usage

To use the API, you have two options. Community and Personal. The easy version is where you just use the pre hosted API along with others. The second option is to use the Personal version.

Personal Version

Note: You require Node.JS installed for this app.

  1. Download the files.
  2. Run npm i express mongoose body-parser to install the dependencies.
  3. Open config.json and fill in the details.
  4. Run node app.js and visit the specified port.

image

Community Version

The community version of DevLunch is finally here! Go to https://devlunchcom.herokuapp.com/ to check it out! This version will have recipes all ever made by anyone who uses DevLunch. You can make up to 100 requests daily on this API. The routes and methods remain the same for the community and personal verison. Please star this repo if you want me to keep improving this project!

Routes

Ok, so you have the API up and running. But how to use it? So, let's get started. Below are the things you can do:

  1. Go to /ingredients/ANY_VEGETABLE_YOU_HAVE_AT_HOME
  2. Go to /recipe/RECIPE_ID
  3. Okay, it's coming...

Documentation

Official documentation is at https://devlunch.js.org

DevLunch+

DevLunch+ is the paid version of this API. Don't worry! It only costs $2 one time fee! This version is not yet here. If you want this, please email me at superzackx@gmail.com. This version will be customized according to your needs.

Contribute

You can contribute by opening a new issue or make a pull request!

Support Us

Please star this repo! It will help a lot. You can fork the repo to make your own version. Make sure you share new versions with using the issues feature.

Thanks to these Amazing People!

PS: Be showcased here by starring the repo!

Stargazers repo roster for @superzackx/DevLunch Forkers repo roster for @superzackx/DevLunch

About

A simple API that gives you a recipe depending on what ingredients you have at home. Please star!

License:MIT License


Languages

Language:JavaScript 100.0%