alanluqman / RecipeApp

RecipeApp Allow Users to save ingredients, keep track of what they have, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe. It keeps track of ( Recipes , Ingredients , Inventory) And all of this will be built in a beautiful and well-organized way.

📗 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

📖 RecipeApp

RecipeApp Allow Users 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. It keeps track of:

- Recipes

- Ingredients

- Inventory
And all of this will be built in a beautiful and well-organized way!

🛠 Built With

Tech Stack

Framework

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Create recipes
• Generate a shopping list
• User can save Ingredients

(back to top)

🚀 Live Demo

• Coming Soon

(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: Ruby invironment latest version, rails latest version, Editor like (VS code)

Setup

Clone this repository to your desired folder

  cd my-folder
  git clone https://github.com/alanluqman/RecipeApp.git

Install

Install this project with:

  cd my-project
  gem install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  bin/rspec  spec

Deployment

You can deploy this project using:

coming soon...

(back to top)

👥 Authors

👤 Alan Luqman

• GitHub: @alanluqman
• LinkedIn: Alan luqman

👤 Gordon Otieno

• GitHub: @gordonotieno
• LinkedIn: Alan luqman

(back to top)

🔭 Future Features

• Realtime messaging

(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, I highly incorage you to give this project star and leave a feedback.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for this wonderful program.

(back to top)

❓ FAQ

Not yet.

(back to top)

📝 License

This project is MIT licensed.

(back to top)