📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 [Recipe App]

The Recipe App will allow you to save ingredients, keep track of what you have, create recipes, create inventory list, 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.

🖼 App Screenshot

🛠 Built With

Tech Stack

Client

• ERB

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Social media share
• Social registration

(back to top)

🚀 Live Demo

• No Live Demo Yet

(back to top)

💻 Getting Started

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

Prerequisites

Getting Started

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

Prerequisites

• Have a computer and internet connection
• Have Ruby installed on your computer
• Have a basic knowledge of Ruby and OOP concept
• Have a general understanding of what testing is
• Have visual-studio code or any other code editor installed on your computer.

Setup

• In order to get a copy of this project you need to download it from https://github.com/Profsain/rails_recipe_app.git
• Extract the zipped file and open it in your code editor

Install

• Run the command bellow in your terminal to get all required files

bundle install

Run Server

• Run the command bellow in your terminal rails server

Run tests

you can run one of the following command in your terminal

1. Run testing

rspec spec

2. Run linters

> Rubocop --color
> Rubocop -A

Authors

👤 Husseini Mudi Profsain

• GitHub: @Profsain
• Twitter: @Profsain
• LinkedIn: Profsain

👤 Ahmad Zaki Yousufi

• GitHub: @zakiyousufi
• LinkedIn: zakiyousufi

👤 Omar Warraich

• GitHub: @Omar Warraich
• Twitter: @omarwarraich1
• LinkedIn: o-va

🔭 Future Features

• Add user profile
• Create reservation method for public rescipes

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse, coding partners, reviewers and anyone else workedwith us.

(back to top)

📝 License

This project is MIT licensed.