Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/c00p75/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/c00p75/recipe-app

Last synced: 2 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.

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)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 [Recipe App]

**Recipe App** is a fully functional website that will show the list of public recipes and empower users to create their own recipes and foods. Users can also generate shopping list from the recipes they have created.

## 🛠️ Built With

### Tech Stack

Client


  • HTML(erb), CSS

Server


  • Ruby

Database


  • Postgress

### Key Features

- **User can sign-up or login**
- **User can create and delete Foods.**
- **User can create, edit and delete Recipes.**
- **User can Generate shopping list.**
- **User can look public recipes.**

(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: any web-browser.

### Setup

Clone this [repository](https://github.com/c00p75/recipe-app.git) to your desired folder.

### Install

To install required dependencies run the following command:

```bash
bundle install
```

### Usage

**To run the project follow the following instruction:-**

- Clone this [repository](https://github.com/c00p75/recipe-app.git) in your local machine with correct branch.
- Run following cmds:-
- **rails db:create**
- **rails db:migrate**
- **rails s**

### Run tests

To run tests, run the following command:

```bash
rspec
```

### Deployment

You can deploy this project using: **Not available**.

(back to top)

## 👥 Authors

👤 Yodit Abebe

- GitHub: [yodit93](https://github.com/yodit93)
- Twitter: [@yodtwit](https://twitter.com/yodtwit)
- LinkedIn: [Yodit Abebe](https://www.linkedin.com/in/yodit-abebe-ayalew/)

## 👥 Authors

👤 George M'sapenda

- GitHub: [@coop75](https://github.com/c00p75)
- LinkedIn: [George M'sapenda](http://www.linkedin.com/in/george-m-sapenda-593750201/)

## 🔭 Future Features

- [ ] **[User Authorizaton]**
- [ ] **[User can follow other users]**

(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 give a ⭐.

(back to top)

## 🙏 Acknowledgments

We would like to thank Microverse.

(back to top)

## 📝 License

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

(back to top)