README.md

Recipe App

📗 Table of Contents

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

📖 Recipe App

This app keeps track of all user recipes, ingredients, and inventory. It allows the user to save ingredients, keep track of what they have, create recipes, and generate a shopping list based on what the user has and what they are missing from a recipe. The app allows users to make the recipies public so that anyone can access them.

🛠 Built With

Tech Stack

Client

• HTML
• CSS

Server

• Rails

Database

• PostgreSQL

Key Features

• Recipe Management

  The app allows users to create and save their own recipes, including ingredients, instructions, and additional details.

• Ingredient Tracking

  Users can keep track of their inventory of ingredients, enabling them to manage what they have on hand and what needs to be replenished.

• Shopping List Generation

  Based on the recipes and ingredients saved, the app generates a personalized shopping list, highlighting the ingredients needed to prepare desired recipes.

• Public Recipe Sharing

  The app provides an option for users to make their recipes public, allowing others to access and view their recipes.

(back to top)

💻 Getting Started

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

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Timbar09/Recipe-app.git

Prerequisites

In order to run this project you need:

• A text editor.
• To install Ruby.
• To install Ruby on Rails.
• To install PostgreSQL.

Install

Install this project's dependencies by running:

  cd my-project
  bundle install
  npm install

Usage

To run the project, execute the following command:

  rails server

(back to top)

👥 Authors

👤 Author	GitHub	Twitter	LinkedIn
Miles Mosweu	@Timbar09	@Milez09	@miles-mosweu09
Mladan Ilic	@Ilic	@Ilic	[@Ilic] (https://www.linkedin.com/in/mladanilic/)

(back to top)

🔭 Future Features

• Add more functionality.

(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 it a ⭐️ and let us know what you like in particular.

(back to top)

🙏 Acknowledgments

I would like to thank the microverse community for the useful content

(back to top)

📝 License

This project is MIT licensed.

(back to top)