michael-duke/Recipe-App

The Recipe App 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

Microverse README Template

📗 Table of Contents

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

📖 Recipe App

Recipe App allows 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 on Rails

Tailwind CSS / Material Tailwind

Database

• PostgreSQL

Key Features

• [Authentication, User can manage his recepies and foods]
• [Guest User can navigate the App and read all ]

(back to top)

🚀 Live Demo

• RecipeOnRails

(back to top)

📇 Entity Relationship Diagram

💻 Getting Started

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

Prerequisites

In order to run this project you need: Git and Ruby

 gem install rails

Install

Install this project with:

  bundle install

  npm install

Create Database (Mandatory)

rails db:create

If you have made a migration then run this command

rails db:migrate

rails db:seed

Usage

To run the project, execute the following command:

  rails server or rails s

Run tests

rspec

(back to top)

👥 Authors

👤 Michael Mesfin

• GitHub: @michael-duke
• Twitter: @MikeDuke21
• LinkedIn: MICHAEL MESFIN

👤Samiullah

• GitHub: @samiullah997
• Twitter: @samiullahk997
• LinkedIn: Samiullah Khan

(back to top)

🔭 Future Features

• [Use importmaps or esbuild for loading JavaScript]
• [Build the API for recipes based on User entries]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

• Hat tip to anyone whose code was used
• Inspiration
• etc

(back to top)

❓ FAQ

• [Question_1]

  • [Answer_1]

• [Question_2]

  • [Answer_2]

(back to top)

📝 License

This project is MIT licensed.

(back to top)