📗 Table of Contents

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

📖 [Recipe App]

[Recipe App] is a project that will help you keep track of all your recipes and ingredients. 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

Client

• Ruby on rails

Database

• PostgreSQL

Bootstrap5

• Bootstrap5

Key Features

• [user]
• [food]
• [recipes]
• [shopping list]
• [public recipes]

(back to top)

🚀 Live Demo

• Live Demo Link

(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:

Install Ruby on your computer Install Rails on your computer

Setup

Clone this repository to your desired folder:

git clone [email protected]:Bhekisile/Recipe-app

Install

Install this project with:

bundle install

Usage

To run the project, execute the following command:

rails server

Run tests

To run tests, run the following command:

rspec

👥 Authors

👤 Bhekisile Jozi

• GitHub: @Bhekisile
• LinkedIn: BhekisileJozi

👤 Ikonde (Arnold) Nekemiah

• GitHub: @arnoldnekemiah
• Twitter: @arnoldikonde
• LinkedIn: Ikonde (Arnold) Nekemiah

(back to top)

🔭 Future Features

• [Add more styling to improve the UI]
• [Add more functionality]

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

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for giving us all the necessary knowledge we need to make this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)