Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bienvenuushindi/recipe-app
The 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.
https://github.com/bienvenuushindi/recipe-app
bootstrap rspec ruby ruby-on-rails
Last synced: 18 days ago
JSON representation
The 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.
- Host: GitHub
- URL: https://github.com/bienvenuushindi/recipe-app
- Owner: bienvenuushindi
- License: mit
- Created: 2022-11-14T07:24:17.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-04T07:27:28.000Z (almost 2 years ago)
- Last Synced: 2023-03-04T14:03:08.942Z (over 1 year ago)
- Topics: bootstrap, rspec, ruby, ruby-on-rails
- Language: Ruby
- Homepage: https://recipeapp.up.railway.app
- Size: 6.11 MB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Microverse README Template
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
> The 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
This project was built using.
Client
Server
Database
> key features of the application.
- **User can register and login**
- **Authenticated User can manage recipes**
- **Authenticated User can manage inventories**
- [Live Demo Link](https://recipeapp.up.railway.app/)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Ruby installed
- Postgresql installed
- git installed [In case you want to clone this repo using your terminal]
- Any IDE or text editor that supports Ruby
### Setup
Clone this repository to your desired folder:
#### 1. Clone this repository or download the Zip folder:"
```bash command
$ git clone https://github.com/bienvenuushindi/recipe-app.git
```
#### 2. Navigate to the location of the folder in your machine:
```bash command
you@your-Pc-name:~$ cd
```
#### 3. Press Enter to navigate to your local clone.
#### 4. Install the gems:
```bash command
bundle install
```
#### 5. Create database and run the necessary migration files :
```bash command
$ bin/rails db:create
$ rake db:migrate
```
#### 6 Finally you can run the server:
```bash command
rails s
```
👤 **Ushindi Bienvenu**
- GitHub: [@usbbush](https://github.com/bienvenuushindi)
- LinkedIn: [@usbbush](https://www.linkedin.com/in/usbbush/)
- 👤 **Talha Khalid**
- GitHub: [@talha](https://github.com/tkz96)
- LinkedIn: [@Khalid](https://www.linkedin.com/in/talha-zuberi/)
👤 Eyasu Teshome
- GitHub: [@EyasuTeshome](https://github.com/EyasuTeshome)
- Twitter: [@EyasuTeshome](https://twitter.com/EyasuTeshome)
- LinkedIn: [Eyasu Teshome](https://linkedin.com/in/eyasu-teshome)
- [ ] **Deploy the recipe application**
- [ ] **Write tests**
- [ ] **Implement API for this web application**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, kindly drop a star.
We would like to thank the Ruby community and Microverse team
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._