An open API service indexing awesome lists of open source software.

https://github.com/praisespjmt/foodpad-app

The FoodPad app keeps track of all users recipes, ingredients, and inventory. It will allows users to save ingredients, keep track of what users have, create recipes, and generate a shopping list based on what users have and what users are missing from a recipe. Built with Ruby on Rails.
https://github.com/praisespjmt/foodpad-app

css3 javascript ruby ruby-on-rails

Last synced: 3 months ago
JSON representation

The FoodPad app keeps track of all users recipes, ingredients, and inventory. It will allows users to save ingredients, keep track of what users have, create recipes, and generate a shopping list based on what users have and what users are missing from a recipe. Built with Ruby on Rails.

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Inkling Blog ](#-inkling-blog-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors ](#-authors-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [📝 License ](#-license-)

# 📖 FoodPad App

> The `FoodPad` app keeps track of all users recipes, ingredients, and inventory.
> It will allows users to save ingredients, keep track of what users have, create
> recipes, and generate a shopping list based on what users have and what users
> are missing from a recipe. Also, since sharing recipes is an important part of
> cooking the app allows users to make them public so anyone can access them.

## 🛠 Built With

### Tech Stack

> Here are the tech stacks applied in this project.

Language

Framework

Database

Linters

Markup Languages

Test Library

(back to top)

### Key Features
> This app has the following key features:
- Create new user.
- Add a food item.
- Add a recipe.
- Make personal recipes public.
- Generate a shopping list for a user based on a recipe.

(back to top)

## 💻 Getting Started

### Prerequisites

In order to run this project you need:

- Install Ruby on your computer (machine)

### Setup
Clone this repository to your desired folder:
```sh
git clone git@github.com:PraisesPJMT/FoodPad-App.git
cd FoodPad-App
```
### Install
Install this project with:
```sh
gem install bundler
bundle install
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
- After running `rails server`, use the app on [http://localhost:3000/](http://localhost:3000/) in the browser!
- For more information please visit [Ruby-on-Rails](https://rubyonrails.org/).

(back to top)

## 👥 Authors
👤 **Paul Onchera** (Kenya)

[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/PraisesPJMT/)
[![LinkedIn](https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/paul-onchera/)

👤 **Praises Tula** (Nigeria)

[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/Paul-js-hub)
[![LinkedIn](https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/praises-tula/)
[![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/PraisesPJMT/)

[![Gmail](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:praisesmusa@gmail.com)
[![AngelList](https://img.shields.io/badge/AngelList-%23D4D4D4.svg?style=for-the-badge&logo=AngelList&logoColor=black)](https://angel.co/u/praises-tula/)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.