BigOven

📗 Table of Contents

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

📖 BigOven

BigOven is a ruby on rails app that help you save your favorites recipes and let you keep track of your food inventory by adding the food in the app, When you want to cook a recipe you can generate a shopping list to see what you missing to be able to do that recipe.

🛠 Built With

• Ruby on Rails

Key Features

• Show the list saved food and quantity.
• Generate shopping list for a given recipe.
• Save favorites recipes.
• Public recipes.

(back to top)

💻 Getting Started

To clone the repository in local environment try following steps.

Prerequisites

• [x] A code editor like Visual Studio Code with Git and Node.js.

You can check if Git is installed by running the following command in the terminal.

$ git --version

Likewise for Node.js and npm for package installation.

$ ruby --version && gem --version

Setup

Clone the repository using this link.

Install

• Ruby
• Ruby on Rails
• Postgresql

Get into development

In the terminal, run these commands to get into development.

$ bundle install (install dependencies)

Usage

To run the project run the command:

  rails server

👥 Authors

👤 Shinhyo Belliard

• GitHub: @ShinhyoBelok
• Twitter: @Bell_iraki
• LinkedIn: LinkedIn

👤 Glenda Diaz

• GitHub: @gjuliao
• LinkedIn: Glenda Diaz

(back to top)

🔭 Future Features

• [ ] Food inventory list
• [ ] Food inventory detail
• [ ] Inventory shopping list
• [ ] Better UX when adding foods to a recipe

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome! Add suggestions by opening new issues.

Feel free to check the issues page..

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

Authors would like to thank:

• Microverse
• Code Reviewers
• Coding Partners

(back to top)

📝 License

This project is MIT licensed.