README.md

📗 Table of Contents

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

📖 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.

App Screen-Shots

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Server

• Ruby on Rails

Database

• PostgreSQL

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)

🚀 Live Demo

• Live 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:

• Laptop/Desktop.
• Internet.
• Vs Code.
• Ruby.
• Rails.
• nodejs.
• yarn.js.
• PostgreSQL.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:Mujeeb4582/Recipe-app.git

Install

Install this project with:

  cd my-project
  bundle install
  rake assets:precompile

Usage

To run the project, execute the following command:

  rails server

or

  bin/dev

Run tests

To run tests, run the following command:

  rspec

Deployment

You can deploy this project using:

  https://render.com/

(back to top)

👥 Authors

👤 Mujeeb ur Rahman

• GitHub:
• Twitter:
• LinkedIn:

👤 Hein Tay Zar

• GitHub:
• Twitter:
• LinkedIn:

(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 a ⭐️.

(back to top)

🙏 Acknowledgments

• Thanks to the Microverse team for the great curriculum.
• Thanks to the my coding partner for the great contributions.
• Thanks to the Code Reviewer(s) for the insightful feedback.
• Hat tip to anyone whose code was used.

📝 License

This project is MIT licensed.

(back to top)