Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

The Recipes 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/estete9/recipes-app

Last synced: about 1 month ago
JSON representation

The Recipes 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

- [📗 Table of Contents](#-table-of-contents)
- [📖 \[RECIPE APP\] ](#-recipe-app-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 [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. 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

- Ruby v3.2.2
- Rails v7.1.2
- Postgresql v14.9
- Devise
- CanCanCan
- Bullet
- Rspec
- Capybara

### Tech Stack

Language

Server

Database

### Key Features

- [User login and sign up]
- [Food and food recipes]
- [Recipies details]

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

Have a suitable installation of Ruby v3.2.2
Have a suitable installation of Postgresql v15

install Rails
```sh
gem install rails
```

### Setup

Clone this repository to your desired folder:

```sh
gh git clone https://github.com/Estete9/recipes-app.git
```
--->

### Install

Install this project with:

```sh
cd Recipe-App
bundle install
rails db:setup
rails db:migrate
```

### Usage

To run the project, execute the following command:

```sh
rails server
```
Open the following ing in your web browser `http://localhost:3000`

### Run tests

To run tests, run the following command:

Example command:

```sh
rspec
```

(back to top)

## 👥 Authors

👤 **Zabih Noori**

- GitHub: [Zabih noori ](https://github.com/ZabihullahNooriWardak)

👤 **Esteban Palacios**

- GitHub: [Esteban ](https://github.com/Estete9)

👤 **Timothy Njoroge**

- GitHub: [Timothy Njoroge](https://github.com/simplegoose)

(back to top)

## 🔭 Future Features

- [ ] **[Inventory list and details]**
- [ ] **[Shopping list based on in inventory availabilty ]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project coomment or send it a star

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for suggesting the app

(back to top)

## 📝 License

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

(back to top)