DiegoMero/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.

📗 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

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.

🛠 Built With

Tech Stack

This project is made with Ruby on Rails.

Client

• Ruby on Rails

Server

• Rails Server

Database

• PostgreSQL

Key Features

• Users can add foos
• Users can add recipes
• Users can see public recipes

(back to top)

💻 Getting Started

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 git@github.com:DiegoMero/recipe-app.git

• Create a .env file in the root directory with your database configuration details following the .env.example file as guide

Install

Install this project with:

  cd recipe-app
  bundle install

Usage

To run the project, execute the following command:

  rails server

(back to top)

👥 Authors

👤 Diego Mero

• GitHub: @DiegoMero
• Twitter: @Dimero18
• LinkedIn: Diego Mero

👤 Emmanuel Orji-Ihuoma

• GitHub: @emmiiorji
• Twitter: @emmiiorji
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Users will be able to update recipes
• Users will be able to update foods
• Users will be able to made an inventory of their foods

(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 feel free to support!

(back to top)

🙏 Acknowledgments

I would like to thank all my coding partners that help me through the obstacles.

(back to top)

📝 License

This project is MIT licensed.

(back to top)