README.md

📗 Table of Contents

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

📖 Recipe App

Recipe App The Recipe App enables users to conveniently manage their recipes, ingredients, and inventory. Users can save ingredients, track their availability, create recipes, and generate a comprehensive shopping list that takes into account the ingredients they have and those they need for a particular recipe. Moreover, as sharing recipes is a crucial aspect of cooking, the application allows users to make their recipes public for easy access by anyone.

🛠 Built With

Tech Stack

• Ruby on Rails.
• SQL.

Key Features

• Users can perform multiple recipe management tasks using the application, such as adding, updating, removing, and displaying recipes and ingredients.
• User authentication is implemented to ensure secure access to the application's features. Additionally, the application is thoughtfully designed with a focus on usability and scalability

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Download Visual Studio Code.
• Download Git.

Setup

Clone this repository to your desired folder:

• Clone the repo

   git clone git@github.com:girma336/Recipe-app.git

Install

• you can run any one of these commands to install bundle on your machine:

- bundle init
- bundle install
- sudo apt bundle install (for Linux)

Usage

• To run the project, execute the following command:

   rails server

(back to top)

👥 Author

👤 Zainab

• GitHub: Zainab-Al-Zubair

👤 Girma Tarekegn

• GitHub: Girma Tarekegn

👤 Jerome Jay Osman

• GitHub: Jerome Jay Osman

(back to top)

🔭 Future Features

• Deploy the project and make it available for every one.

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

(back to top)

🙏 Acknowledgments

A list of resources that i find helpful and would like to give credit to :

• Microverse
• GitHub
• Ruby

(back to top)

📝 License

This project is MIT licensed.

(back to top)