📗 Table of Contents

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

📖 recipe-app

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

• PostgreSQL

Key Features

• A login page.
• A registration page.
• A food list.
• A recipes list.
• A general shopping list view.
• A list of all public recipes from other users with their names and total prices.

(back to top)

💻 Getting Started

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

• Create a local directory where you can clone the project
• Clone the project to your directory by running
  • git clone https://github.com/Matthieu96Code/recipe-app.git
• Run the code with ruby

Prerequisites

In order to run this project you need:

• Git and GitHub
• A code editor
• Ruby on rails

Setup

Clone this repository to your desired folder:

• Create a local directory where you can clone the project
• Clone the project to your directory by running
  • git clone https://github.com/Matthieu96Code/recipe-app.git

Install

Install this project with:

  cd my-project
  gem install
  rails db:create
  rails db:migrate

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command: Install through : gem install rspec

  rspec

👥 Authors

👤 SENOU Kodjo Matthieu

• GitHub: @Matthieu96Code
• Twitter: @MatthieuSENOU
• LinkedIn: Kodjo Matthieu SENOU

(back to top)

🔭 Future Features

• [ ] Inventories list.
• [ ] Inventory shopping list.

(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 kindly leave a ⭐

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the great resources shared.

(back to top)

📝 License

This project is MIT licensed.

(back to top)