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.

📗 Table of Contents

• 📗 Table of Contents
• 📖 Inkling Blog
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • 👥 Authors
  • 🤝 Contributing
  • ⭐️ Show your support
  • 📝 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

• Ruby
• JavaScript

Framework

• Ruby on Rails

Database

• PostgreSQL

Linters

• Rubocop
• Stylelint

Markup Languages

• HTML5
• CSS3

Test Library

• RSpec

(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:

  git clone [e-mail]:PraisesPJMT/FoodPad-App.git
  cd FoodPad-App

Install

Install this project with:

  gem install bundler
  bundle install

Usage

To run the project, execute the following command:

  rails server

• After running rails server, use the app on http://localhost:3000/ in the browser!
• For more information please visit Ruby-on-Rails.

(back to top)

👥 Authors

👤 Paul Onchera (Kenya)

👤 Praises Tula (Nigeria)

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

📝 License

This project is MIT licensed.