📗 Table of Contents

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

📖 Recipe App

Recipe-App is a web app that 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

• Ruby on Rails

Tech Stack

• Ruby
• Ruby on Rails

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• allow you to save ingredients
• generate a shopping list
• create recipes
• keep track of what you have

(back to top)

🚀 Live Demo

Not Available yet!

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

• You should be having Ruby installed on your computer

Setup

To get a local copy up and running follow these simple example steps.

1. Navigate to a folder where you want the cloned file to appear

2. Clone this repo in your terminal or git bash using the command

  cd Blog
  git clone https://github.com/degisew/Recipe-App.git

3. run the following command to install all the necessary dependencies including the linters

 cd Recipe-App
 gem install

4. Navigate to the folder called Blog/ and open this project using your editor

Usage

To run the project, execute the following command:

  cd Recipe-App
 rails server

• This will start the rails server in your browser

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

Run tests

To run tests, run the following command:

  bin/rails test test/models/article_test.rb  or
  bin/ rails rsepc sepc/

Deployment

You can deploy this project using:

• Heroku

(back to top)

👥 Authors

👤 Degisew

• GitHub: @degisew
• Twitter: @Dj_etiya
• LinkedIn: Degisew

(back to top)

🔭 Future Features

• [Implement Front-end UI using react]
• [Deploy Online]

(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 give a ⭐️ to repo.

(back to top)

🙏 Acknowledgments

I would like to thank the Microverse team.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)