getssh/Recipe-app

Rails Recipe App

📗 Table of Contents

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

📖 Rails Recipe App

Rails 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

Client

• Ruby on Rails

Server

• localhost

Database

• PostgreSQL

Key Features

• [Keep track of all your recipes, ingredients, and inventory]
• [Create recipes, and generate shopping lists]

Back to top

💻 Getting Started

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

Prerequisites

• You'll need any code editor

Setup

Clone this repository to your desired folder:

  git clone https://github.com/ghreza-crypto/Recipe-app.git
  cd Rails-Recipe-App

Install

Install this project with:

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

  rails db:migrate RAILS_ENV=test
  rspec

👥 Authors

👤 Ghulam Reza Rajabi

• GitHub: @ghreza-crypto
• LinkedIn: LinkedIn

👤 Getayawkal Tamrat

• GitHub: @getssh
• LinkedIn: LinkedIn

Back to top

🔭 Future Features

• [Improve UI design]
• [Improve the desktop version]

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 you can give it a star!

Back to top

🙏 Acknowledgments

I would like to thanks Microverse for this learning opportunity.

Back to top

📝 License

This project is MIT licensed.

Back to top