alicemirigo92 / Recipe-App

This is a simple app to keep 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

• Live Demo

  • 🛠 Built With
    • Tech Stack
    • Key Features

• 💻 Getting Started

  • Setup
  • Prerequisites
  • Usage

• 👥 Authors

• 🔭 Future Features

• 🤝 Contributing

• ⭐️ Show your support

• 🙏 Acknowledgements

• 📝 License

📰 Recipe-App

Tech Stack

• ROR
• Postgresql

Key Features

• Add Food
• Add user
• Add Recipe
• Add User Authentication
• View Food and Recipe
• Add test

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

• git use the following link to setup git if you dont have it already installed on your computer Install git

• Ruby use the following link to setup Ruby if you dont have it already installed on your computer Install ruby

• Rails use the following link to setup Rails if you dont have it already installed on your computer Install rails

• PostgreSQL use the following link to setup PostgreSQL if you dont have it already installed on your computer Install postgresql

Setup

Clone this repository to your desired folder: Example command:

  git clone https://github.com/Divinity-dev/Recipe-App
  cd recipe-app

Install

Example command:

  cd recipe-app
  bundle install (install all dependencies)

Usage

To run the project redirecting to the root directory of the project and run the following command:

 bin/rails server (to run web application)

Test

To test the web app run the following command:

 rspec spec (  to test the console application)

👥 Authors

👤 Alice Mirigo

• GitHub: Alice Mirigo
• Twitter: @Gathonimirigo
• LinkedIn: Alice

👤 Divine Asiriuwa

• GitHub: @githubhandle
• LinkedIn: linkedIn

(back to top)

🔭 Future Features

• User Profile.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

We would like to thank microverse community for the support and guidance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)