jodavid444 / Recipe-app

A user-friendly app for organizing recipes and ingredients, enabling users to save, track, and create recipes while generating shopping lists based on missing ingredients. This repository provides a seamless solution for efficient recipe management and streamlined shopping planning. Built with Ruby on Rails, PostgreSQL and RSpec.

" Everyday life is like programming, I guess. If you love something you can put beauty into it." - Sabrina Bryan

Ruby on Rails : Reciep app project

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖About the Project

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.

🛠 Built With

Tech Stack

• Ruby
• Ruby on Rails
• PostgreSQL

Key Features

• Login page
• A registration page.
• 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.
• Inventories list (with all CRUD implementation, except for 'update').
• Inventory shopping list, a shopping list, but only taking into consideration a chosen recipe and inventory.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Install

Clone the repository

git clone https://github.com/hienphan0111/Recipe-app.git
cd catelog-of-thing

Check your Ruby version

ruby -v
rails -v

The ouput should start with something like ruby 3.2.2

If not, install the right ruby version using rbenv (it could take a while):

rbenv install 3.2.2
gem install rails

Install dependencies

Using Bundler and Yarn:

bundle install

or

yarn install

run program demo

rails s

run test

To run a single Rspec test file, you can do the following to run the tests in the your_spec.rb file:

rspec spec rspec/your_spec.rb

To run all Rspec test files in a directory

rspec spec rspec

(back to top)

👥 Authors

👤 Hien Phan

• GitHub: hienphan0111
• Twitter: hienphan0111
• LinkedIn: mr-hienphan

👤 Stanley Kibor

• GitHub: @chepkok3
• Twitter: @chepkok3
• LinkedIn: @chepkok3

👤 Joseph David

• GitHub: @josephDavid
• Twitter: @chepkok3
• LinkedIn: @chepkok3

(back to top)

🔭 Future Features

• User dashboard

(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 me a star.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse which provided me all knowledge about full stack development.

(back to top)

📝 License

This project is contributed under GNU 3.0 licensed.

(back to top)