An open API service indexing awesome lists of open source software.

https://github.com/karayamanemre/recipe-app

The Recipe app keeps track of all your recipes, ingredients, and inventory. It allows 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/karayamanemre/recipe-app

postgresql recipe-app rubyonrails

Last synced: 12 days ago
JSON representation

The Recipe app keeps track of all your recipes, ingredients, and inventory. It allows 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.

Awesome Lists containing this project

README

          

# πŸ“— 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)
- [πŸ‘₯ Authors](#authors)
- [πŸ”­ Future Features](#future-features)
- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ“ License](#license)

# πŸ“– [Recipe App]

**The Recipe app** keeps track of all your recipes, ingredients, and inventory. It allows 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

Server

Database

### Key Features

- **[Register a user]**
- **[Login a user]**
- **[Create ingredients]**
- **[Create Recipes]**
- **[Generate shopping list]**
- **[Add Ingredients to a recipe]**
- **[View Public Recipes]**

(back to top)

## πŸš€ Live Demo

- [Recipe App](https://recipe-app-8dxv.onrender.com/)

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

```sh
gem install rails
```

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/karayamanemre/recipe-app.git
```

### Install

Install this project with:

```sh
cd recipe-app
bundle install
```

### Usage

To run the project, execute the following command:

```sh
rails server
```

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Author1**

- GitHub: [Emre Karayaman](https://github.com/karayamanemre)
- LinkedIn: [Emre Karayaman](https://www.linkedin.com/in/emre-karayaman-a7b45b243/)

πŸ‘€ **Author2**

- GitHub: [Kwasi Baayeh](https://github.com/Baayeh/)
- LinkedIn: [Kwasi Baayeh](https://www.linkedin.com/in/kabaayeh)

(back to top)

## πŸ”­ Future Features

- [ ] **[Like a recipe]**
- [ ] **[Comment on a recipe]**
- [ ] **[Share private recipes]**

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project, kindly give it a star⭐️

(back to top)

## πŸ“ License

This project is [MIT](./LICENSE) licensed.

(back to top)