📗 Table of Contents

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

📖 RecipeApp - RoR group 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. 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

Key Features

• [Add new recipes, ingredients and inventory]
• [List recipes, ingredients and inventory]
• [Share recipes to make them public]
• [Authorization and Authentication]

Back to top

🚀 Live Demo

Video Demo Link

Comming soon

💻 Getting Started

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

Prerequisites

• You'll need any code editor

Setup

Clone this repository to your desired folder:

  git clone git@github.com:cabraham1/RecipeApp-RoR-group-project.git
  cd RecipeApp-RoR-group-project

Install

Install this project with:

  bundle install
  rails db:create
  rails db:migrate
  rails db:seed

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rails db:migrate RAILS_ENV=test
  rspec

👥 Authors

🕵🏽‍♀️ Abraham Christopher

• GitHub: @cabraham1
• Twitter: @_cabraham
• LinkedIn: Abraham Christopher

🕵🏽‍♀️ Yoseph Addisu

• GitHub: @yosaddis
• Twitter: @yosaddis
• LinkedIn: Yoseph Addisu

Back to top

🔭 Future Features

• [ ] [Improve UI design]
• [ ] [Improve the desktop version]

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 you can give it a star!

Back to top

🙏 Acknowledgments

I would like to Microverse community for helping me to improve my skills.

Back to top

📝 License

This project is MIT licensed.

Back to top