OscarFMdev / recipe-inventory

Recipe app built with rails that allows the user to register recipes, foods and watch other people's recipes.

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

Receipe Inventory

The Recipe inventory web 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.

🛠 Built With

Tech Stack

Client

• CSS

Database

• PostgreSQL

Key Features

• [Unique user sessions per login]
• [Foods and recipe sync to get a general shopping list]
• [Recipes can be made private or public]

(back to top)

🚀 Live Demo

Live Demo

• Live Demo

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

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [e-mail]:OscarFMdev/recipe-inventory.git

Install

Install this project with:

  cd recipe-inventory
  gem install

--->

Usage

To run the project, execute the following command:

  rails db:migrate

  rails db:seeds

  rails server

--->

Run tests

To run tests, run the following command:

  bin/rails rspec

Deployment

You can deploy this project using:

nill....

(back to top)

👥 Authors

👤 Author1: Oscar Fernández Muñoz

• GitHub: @OscarFMdev
• Twitter: @OscarFMdev
• LinkedIn: LinkedIn

👤 Author2: Shedrack Sunday

• GitHub: @Shedrack-Sunday
• Twitter: @DeleSundayS
• LinkedIn: @Shedrack Sunday

(back to top)

🔭 Future Features

• [Abikity to upload images]
• [Refactoring of stying witha framework]
• [Connnecting to an external API to get recipe]

(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 we'll be glad to see you show some support with stars :wink

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for inspring the design of the project

(back to top)

❓ FAQ

• [Question_1]

  • [Answer_1]

• [Question_2]

  • [Answer_2]

(back to top)

📝 License

This project is MIT licensed.

(back to top)