ZikaZaki/recipe-stash

Your personal recipes manager where you can share your recipes with family and friends or simply store them in a nicely organized way. Built with Ruby on Rails.

Recipe-Stash

📗 Table of Contents

• 📗 Table of Contents
• 📖 RecipeStash
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 Recipe-Stash

The Recipe-Stash app keeps track of all recipes, ingredients, and inventory. It allows users to save ingredients, keep track of what they have, create recipes, and generate a shopping list based on what they have and what they are missing from a recipe. Also, the app enables users to make their recipes public so anyone can access them.

🛠 Built With

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Client

• React.js

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• [Manage Food Records]
• [Manage Recipes Records]
• [Create Public Recipes]
• [Manage User Profile]

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Live Demo Link

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

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

Prerequisites

In order to run this project you need:

Setup

Clone this repository to your desired folder:

Install

Install this project with:

Usage

To run the project, execute the following command:

Run tests

To run tests, run the following command:

Deployment

You can deploy this project using:

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Zakariya Al-Khamisi (ZikaZaki)

• GitHub: ZikaZaki
• Twitter: Zakariya Al-Khamisi
• LinkedIn: Zakariya Al-Khamisi

👤 Marvellous Ibironke

• GitHub: @Tommy Marvel
• Twitter: @Tomiwa Ibironke
• LinkedIn: Marvellous Ibironke

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [Add Inventories]
• [Generate Shopping List]
• [Add User Picture]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank...

(back to top)

❓ FAQ (OPTIONAL)

Add at least 2 questions new developers would ask when they decide to use your project.

• [Question_1]

  • [Answer_1]

• [Question_2]

  • [Answer_2]

(back to top)

📝 License

This project is MIT licensed.

(back to top)