Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gh-reza/recipeapp


https://github.com/gh-reza/recipeapp

Last synced: 9 days ago
JSON representation

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

# 📖 [Recipes App]

**[Recipes App]** a ruby on rails project that allows users to create recipes, shopping lists, and foods

## 🛠 Built With

### Tech Stack

Ruby on Rails

### Key Features

- **Create Recipes**
- **Create Shopping Lists**
- **Add foods**

## 💻 Getting Started

RecipeApp

### Prerequisites

In order to run this project you need:

Ruby 3.0.1 or above
Rails 7.07 or above

### Setup

```https://github.com/Gh-Reza/RecipeApp.git```

### Install

go to the folder of the repository, and run this line in the terminal to install dependences:

```bundle install```

### Usage

run ```rails db:create db:migrate```
run ```rails s```

### Run tests

run ```rspec spec```

### Deployment

No deployment implemented yet

(back to top)

## 👥 Authors

👤 **Marc Raphael**

- GitHub: [@Marc Raphael](https://github.com/Marcraphael12)
- Twitter: [@Marc Raphael](https://twitter.com/marcraphael4)
- LinkedIn: [@Marc Raphael](https://www.linkedin.com/in/marc-raphael)

👤 **Reza Merzaie**

- GitHub: [@Gh-Reza](https://github.com/Gh-Reza)
- Twitter: [@RezaMerzie](https://twitter.com/RezaMerzaie7)
- LinkedIn: [@RezaMerzie](https://www.linkedin.com/in/reza-merzaie)

(back to top)

## 🔭 Future Features

- Form to create inventory

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/theresetuyi/Ruby-on-Rails-group-project/issues).

(back to top)

## ⭐️ Show your support

If you like this project give it a star ⭐️

(back to top)

## 🙏 Acknowledgments

**We would like to thank to Microverse for giving this inspiring project**

(back to top)

## 📝 License

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

(back to top)