About the project

📗 Table of Contents

• 📗 Table of Contents
• 📖 Recipe App
  • 🛠 Built With
    • Ruby on Rails
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
    • Run tests
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Recipe App

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

🛠 Built With

Ruby on Rails

Client

• React.js

Server

• Ruby

Database

• PostgreSQL

Key Features

• Login page and registration page built with Devise
• A food list (with all CRUD implementation, except for 'update')
• A recipes list (with all CRUD implementation, except for 'update')
• A general shopping list view (all missing food for all your recipes and total price)
• A list of all public recipes from other users with their names and total prices
• Recipe details page allowing owner to add new food:
• Inventory page allowing owner to add new food:
• Navigate menu allowing users to open created pages
• Set up with Rspec and Capybara testing libraries

(back to top)

🚀 Live Demo

Live Demo link will be added at the end of the project

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

Ruby installed Postgresql installed

gem install rails

Setup

Clone this repository to your desired folder: git clone https://github.com/iAmWaris97/recipe-app.git

cd recipe-app

Usage

To run the project, execute the following command: rails server

Run tests

To run tests, run the following command: rspec

(back to top)

👥 Author

👨‍💻 Waris Haleem

• GitHub: @iAmWaris97
• Twitter: @iAmWaris97
• LinkedIn: Waris Haleem

👤 Erick Hans Martinez

• GitHub: @erickhansx
• Twitter: @TheErickHans
• LinkedIn: LinkedIn

👤 Ndorrh Oswald Ebu

• GitHub: @ndorrh
• Twitter: @Ndorrh Ebu
• LinkedIn: ndorrh

(back to top)

🔭 Future Features

• Create following system
• Add option to allow users to comment on recipe
• Add like and comments and recipe

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give it stars on GitHub.

(back to top)

🙏 Acknowledgments

I would like to thank the Microverse organization and Ruby on Rails co founders for providing the documentations on RoR technology.

(back to top)

❓ FAQ

• What is this app about?

  • This is a recipe app, where users can create and view recipe.

• What are the technologies used building this app?

  • Main technologies used in this app are (Ruby, Rails, and PostgreSQl)

(back to top)

📝 License

This project is MIT licensed.

(back to top)