Recipe app

📗 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]

The Recipe app keeps track of all your recipes, ingredients, and inventory. It 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.

[Recipe app] is a recipe manager website.

🛠 Built With

Tech Stack

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

Client

• React.js
• HTML
• CSS

Server | Backend

• Ruby on rails

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• [Delete added items]
  • Delete and update items in the app.
• [Add Recipes, Foods and Ingredients]
  • Interact with recipes, foods and recipe foods.
• [Sign in and sign up]
  • User authentication. Set recipe to either public or private.

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Live Demo Link coming soon

(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:

 gem install rails

Setup

Clone this repository to your desired folder:

  cd recipe-app
  git clone https://github.com/itsmraga-hub/recipe-app.git
  cd recipe-app
  Open in your favorite editor

Install

Install this project with:

  cd recipe-app
  gem install
  bundle 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:

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 William Raga

• GitHub: @itsmraga-hub
• Twitter: @RagaMacharia
• LinkedIn: William Raga

👤 Yunus Ali

• GitHub: @IamYunusALi
• Twitter: @IamYunusAli
• LinkedIn: Yunus Ali

(back to top)

🔭 Future Features

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

• [Inventory]
• [Inventory details]
• [Inventory Shopping List]

(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

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)