Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

The Recipe app keeps track of all your recipes, ingredients, and inventory. It will allow to save ingredients, keep track of what you have, create recipes, and generate a shopping list. Also, sharing recipes publicly.
https://github.com/estete9/recipe-app-

Last synced: about 1 month ago
JSON representation

The Recipe app keeps track of all your recipes, ingredients, and inventory. It will allow to save ingredients, keep track of what you have, create recipes, and generate a shopping list. Also, sharing recipes publicly.

Awesome Lists containing this project

README

        




RECIPE APP

- [📖 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)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

**Recipe App**

In this project, we implement the basic setup for a rails project: using gitflow, setting up Rails with PostgreSQL, Devise and RSpec and Capybara.

## 🛠 Built With

### Tech Stack

#### RoR
#### POSTGRESQL

### Key Features

- **Install Ruby on Rails framework**
- **Use Ruby gems as a software packages system**
- **Use database migration files to maintain database schema**
- **Run integration tests**
- **Authentication**
- **Authorization**

(back to top)

## 💻 Getting Started

### PRE-REQUISITE

In order to run this project you need:

VS_CODE
POSTGRESQL
RoR

### Setup

Clone this repository to your desired folder:

mkdir recipe-app
cd recipe-app
git clone https://github.com/Estete9/Recipe-App-.git

### Install

- To retrieve the dependencies of this project, run `bundle install`

(back to top)

### Usage

- Run the following commands to migrate database and start the app
```
rails db:create db:migrate db:migrate RAILS_ENV=test
bundle install
rails s
```

(back to top)

### Test

- To run the tests please run the following command
```
rspec spec
```

(back to top)

## 👥 Authors

👤 **Esteban Palacios**

- GitHub: [@Estete9](https://github.com/Estete9)
- Twitter: [@NaughTban](https://twitter.com/NaughTban)
- LinkedIn: [Esteban Palacios](https://www.linkedin.com/in/dev-esteban-palacios/)

👤 **Jose RM**

- GitHub: [@Joramot](https://github.com/joramot)
- Twitter: [@El_rulis](https://twitter.com/el_rulis)
- LinkedIn: [jose-RM](https://linkedin.com/in/jose-RM)

👤 **Erwin Amador**

- GitHub: [@eamador1](https://github.com/eamador1)
- Twitter: [@hokieamador](https://twitter.com/hokieamador)
- LinkedIn: [@hokiemador](https://www.linkedin.com/in/hokieamador/)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Estete9/Recipe-App-/issues).

(back to top)

## ⭐️ Show your support

If you like this project, please give me a star ⭐️

(back to top)

## 🙏 Acknowledgments

I would like to thank my teammates at Microverse. You are the best!

(back to top)

## 📝 License

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

(back to top)