https://github.com/k0ppai/recipe_app
A rails app that you can use to easily save ingredients, monitor your available inventory, create your own recipe, and even auto-generate a shopping list based on the ingredients required for your chosen recipes.
https://github.com/k0ppai/recipe_app
bootstrap ruby-on-rails
Last synced: about 2 months ago
JSON representation
A rails app that you can use to easily save ingredients, monitor your available inventory, create your own recipe, and even auto-generate a shopping list based on the ingredients required for your chosen recipes.
- Host: GitHub
- URL: https://github.com/k0ppai/recipe_app
- Owner: K0ppai
- License: mit
- Created: 2023-10-09T08:23:44.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2023-10-14T12:48:44.000Z (over 2 years ago)
- Last Synced: 2025-02-04T08:44:18.078Z (over 1 year ago)
- Topics: bootstrap, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 251 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Recipe_App
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**Recipe_App** is a comprehensive app designed to streamline your culinary experience. It serves as your digital kitchen companion, efficiently managing your recipes, ingredients, and pantry inventory. With this app, you can easily save ingredients, monitor your available stock, craft delectable recipes, and even auto-generate a shopping list based on the ingredients required for your chosen recipes.
Client
Database
Bootstrap5
### Key Features
- Ruby
- Rails
- PostgreSQL (RDB)
- Bootstrap5
> To start and run this project
```
bundle install
```
```
rails s
```
To get a local copy up and running, follow these steps.
### Prerequisites
- IDE to edit and run codes (Strongly recommend Visual Studio Code 🔥).
- Git.
- PostgreSQL installed
### Install & Setup
To setup and install this project, follow the below steps:
- Clone this project by the command:
```
$ git clone https://github.com/K0ppai/Recipe_App.git
```
- Then switch to the project folder by the bellow query:
```
$ cd Recipe_App
```
- Install the required dependencies with `bundle install`
- Install npm dependencies with `npm install`
- Run `rails db:setup`
- Run `rails db:migrate`
- With Ruby on Rails and PostgreSQL installed in your environment, you can run `rails server` or `rails s` to run the website.
- Run `rails db:seed RAILS_ENV=test` to seed the testing database
- Run `rspec`
👤 **Paing Soe Thu**
- GitHub: [@K0ppai](https://github.com/K0ppai)
- LinkedIn: [Paing Soe Thu](https://www.linkedin.com/in/paingsoe-thu/)
👤 **Manzi Tresor**
- GitHub: [@manzitresor](https://github.com/manzitresor)
- LinkedIn: [Manzi Tresor](https://www.linkedin.com/in/manzi-tresor-783b4022a/)
👤 **Prosper Kessie**
- GitHub: [@kessie2862](https://github.com/kessie2862)
- LinkedIn: [Prosper Kessie](https://www.linkedin.com/in/prosperkessie/)
- [ ] **Add more interactivity and functionality**
- [ ] **Add more styling to improve the UI**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/K0ppai/Recipe_App/issues).
> If you like this project give it a ⭐️
- We would like to thank Microverse and coding partners for their amazing contribution to the success of this project.
This project is [MIT](https://github.com/K0ppai/Recipe_App/blob/develop/LICENSE) licensed.