📗 Table of Contents

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

📖 Recipe-App

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

Tech Stack

Ruby

• Ruby

Rails

• Rails

PostgreSQL

• PostgreSQL

Key Features

• Display Recipes
• Display Foods
• Create or Remove Recipe
• Create or Remove Food
• Validation and Unit Tests
• Capybara
• Devise and Authorization
• Forms, Views, Controllers

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

 gem install rails

Setup

Clone this repository to your desired folder:

   git clone [email protected]:mailsg/recipe-app.git
   cd recipe-app

Install

Install this project with:

  cd recipe-app
  bundle install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec

(back to top)

👥 Authors

👤 Sandeep Ghosh

• GitHub: @mailsg
• LinkedIn: LinkedIn

👤 Gisa Chris

• GitHub: @gisachris
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Social Networking
• Chef's Forum
• Virtual Meetings

(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 consider leaving a star in the repo.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving me this opportunity to showcase my skills. I would also like to thank the Open Source Community for providing vast resources for free that helped in various stages of this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)