derrick1451 / Recipe-app

📗 Table of Contents

• 📗 Table of Contents
• 📖 Recipe App
  • 🛠 Built With
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 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.

🛠 Built With

Tech Stack

• Ruby on Rails
• PSQL
• Webpack

Key Features

• Display food list

• Display recipes

• Display general shopping list

• Display invetory

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

Example command:

 Install Ruby
 Install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git [e-mail]:derrick1451/Recipe-app.git

Usage

To run the project, execute the following command:

  rails s

Run tests

To run tests, run the following command:

  rails test

(back to top)

👥 Authors

👤 Okongo Derrick

• GitHub: @derrick1451
• LinkedIn: @derrick

👤 Kagiso Sebogodi

• GitHub: @skayjeee
• LinkedIn: kagiso

(back to top)

🔭 Future Features

• Add GUI

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

If you like this project, give it a star.

(back to top)

🙏 Acknowledgments

Special thanks goes to the Microverse community

(back to top)

📝 License

This project is MIT licensed.

(back to top)