Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mailsg/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. The app allows you to make recipes public so anyone can access them.
https://github.com/mailsg/recipe-app

capybara-rspec css3 devise-token-auth rspec ruby-on-rails

Last synced: about 7 hours 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. The app allows you to make recipes public so anyone can access them.

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)
- [💻 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

**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. Also, since sharing recipes is an important part of cooking the app should allow you to make them public so anyone can access them.

## 🛠 Built With

### Tech Stack

Ruby

Rails

PostgreSQL

### Key Features

- **Display Recipes**
- **Display Foods**
- **Create or Remove Recipe**
- **Create or Remove Food**
- **Validation and Unit Tests**
- **Capybara**
- **Devise and Authorization**
- **Forms, Views, Controllers**

(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
git clone [email protected]:mailsg/recipe-app.git
cd recipe-app
```

### Install

Install this project with:

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

### Usage

To run the project, execute the following command:

```sh
rails server
```

### Run tests

To run tests, run the following command:

```sh
rspec
```

(back to top)

## 👥 Authors

👤 **Sandeep Ghosh**

- GitHub: [@mailsg](https://github.com/mailsg)
- LinkedIn: [LinkedIn](https://linkedin.com/in/sandeep0912/)

👤 **Gisa Chris**

- GitHub: [@gisachris](https://github.com/gisachris)
- LinkedIn: [LinkedIn](https://linkedin.com/in/gisa-chris/)

(back to top)

## 🔭 Future Features

- [ ] **Social Networking**
- [ ] **Chef's Forum**
- [ ] **Virtual Meetings**

(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 consider leaving a star in the repo.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for giving me this opportunity to showcase my skills. I would also like to thank the Open Source Community for providing vast resources for free that helped in various stages of this project.

(back to top)

## 📝 License

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

(back to top)