Skip to content

KitchenGenie is a recipe sharing web app that helps home cooks find inspiration and get organized in the kitchen. With a collection of recipes, an intuitive recipe editor, and a smart shopping list feature, KitchenGenie simplifies the recipe creation and meal planning process. Built with Ruby on Rails(RoR)

License

Notifications You must be signed in to change notification settings

tobuya/kitchen-genie

Repository files navigation

Table of Contents

👨‍🍳 Kitchen Genie - Recipe Share App

KitchenGenie is a recipe sharing web app that helps home cooks find inspiration and get organized in the kitchen. With a collection of recipes, an intuitive recipe editor, and a smart shopping list feature, KitchenGenie simplifies the recipe creation and meal planning process.

(back to top)

🧰 Tech Stack

  • Ruby on Rails
  • PostgreSQL
  • Devise
  • RSpec

(back to top)

✨ Key Features

  • Create your own recipes easily
  • Share your recipes with other users
  • Browse through collection of public recipes
  • Generate shopping list based on the necessary ingredients
  • Sign up or log in to your account to access exclusive features

(back to top)

🚀 Live Demo

kitchen-genie

📘 Getting Started

To run this project locally, you'll need to follow these steps.

📋 Prerequisites

Make sure you have the following installed on your machine:

📂 Setup

Clone this repository to your desired foler.

cd my-project
git clone [email protected]:tobuya/kitchen-genie.git .

📥 Installation

Install the required gems with:

bundle install

💾 Database

Create the databases and run migrations with:

rails db:create
rails db:migrate

To load the sample data, run:

rails db:seed

💻 Usage

To run the development server, execute the following command:

rails server

🧪 Run tests

To run tests, run the following command:

rspec spec --format doc

(back to top)

👨‍🚀 Authors

👤 Thomas Obuya

👤 Hein Thant

(back to top)

🎯 Future Features

  • Create inventory system
  • Mobile responsive design
  • Search and filter recipes

(back to top)

🤝 Contribution

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, please consider giving it a ⭐.

(back to top)

🙏 Acknowledgements

We developed this app as a group project during the Microverse program. We would like to express our thanks to all the people who have helped us during the development of this app.

(back to top)

📜 License

This project is MIT licensed.

(back to top)

About

KitchenGenie is a recipe sharing web app that helps home cooks find inspiration and get organized in the kitchen. With a collection of recipes, an intuitive recipe editor, and a smart shopping list feature, KitchenGenie simplifies the recipe creation and meal planning process. Built with Ruby on Rails(RoR)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published