Benawi / Reciep-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.

🛰Recipe app 🚀

📗 Table of Contents

• 📗 Table of Contents
• 📖 Recipe app
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Run localy
    • Run Tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 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. The project is a repository consisting of the following files:

• Ruby files
• Rails files
• Ruby linters file

🛠 Built With

Tech Stack

• Ruby
• Rails
• PostgreSQL

Key Features

• A login page.
• A registration page.
• A food list (with all CRUD implementation, except for 'update').
• A recipe 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.
• Table and column names match the ERD diagram with developed

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• Ruby installed and running. To get more information, read the installation instructions.
• You should be able to use IRB.
• First of all, make sure you have both Ruby & Rails installed on your machine (else You can install Rails just with this simple command gem install rails)

Setup

Clone this repository to your desired folder:

  git clone https://github.com/lorenzoworx/Reciep-App.git
  cd Recipe-App

Install

Install project dependencies with:

  bundle install

Run locally

• Then go to the right folder

$ cd Recipe-App

$ bundle

and run to install npm package

$ npm install

make sure the database is up and running.

$ rails db:create

When you add a migration file, you can add commands like

$ rails db:migrate

Run this command line to add some dummy data

$ rails db:seed

• Finaly run rails s and visit http://localhost:3000/ in your browser!

Run Tests

Go to your gemfile and add the RSpec gem in the development, test group:

group:development, test do  
 gem 'rspec-rails'
end

Then in your terminal run the command:

 $ bundle install

To set up RSpec in your app and create the Spec folder run:

 $ rails generate rspec:install

To run Request specs locally you need just to run the following command in your terminal :

$ rspec spec/
$ rspec spec/ --format documentation 

(back to top)

👥 Authors

👤 Habtamu Alemayehu

• GitHub: Benawi
• Linkedin: Habtamu

👤 : lorenzoworx

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 : otmaneechchafyky

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Optimize the performance of the app.
• Make the UI more user friendly

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

Give us ⭐️ If you like this project!

(back to top)

🙏 Acknowledgments

• We wanted to take a moment to express my sincere gratitude for the opportunity to work with you all on this project.
• Microverse, thank you for providing the structure, guidance, and community to help me level up my skills as a developer. The experiential learning model has been invaluable in improving my coding abilities and collaboration skills. I appreciate the code reviews and feedback to help me write cleaner, more professional code.

(back to top)

📝 License

This project is MIT licensed.

(back to top)