Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/baqar-abbas/recipe-app-capstone

The Recipe app keeps track of all your recipes, ingredients, and inventory. It allows 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/baqar-abbas/recipe-app-capstone

bootstrap5 css postgresql ruby-on-rails

Last synced: about 20 hours ago
JSON representation

The Recipe app keeps track of all your recipes, ingredients, and inventory. It allows 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

        

![](https://img.shields.io/badge/Microverse-blueviolet)

> # Recipe Application

| Project Login Page |
|---------------------------------------|
|![image](https://github.com/baqar-abbas/recipe-app-capstone/assets/111179533/8178ab57-dbb2-40ad-9bdc-c5f605fb70e7)|

# 📗 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 Application]

> **[Recipe-App]** The Recipe app keeps track of all your recipes, ingredients, and inventory. It allows 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.
## 🛠 Built With

### Tech Stack

Client

Server

Database

### Key Features

- **[Design the Application]**
- **[Login page and registration page]**
- **[Authentication]**
- **[Navigation menu]**
- **[General Shopping List]**
- **[Food list]**
- **[Recipes list]**
- **[Recipe details]**
- **[Public recipe list]**
- **[Unit and integration tests]**
- **[RSpec and Capybara testing]**

| Implemented Schema's ERD |
|---------------------------------------|
|![recipe_erd_2_members](https://github.com/baqar-abbas/recipe-app-capstone/assets/111179533/2200fd17-a5f5-4b47-895d-abc5e05f132f)|

(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:
- [Ruby on Rails](https://rubyonrails.org/) installed and running. To get more information, read the [installation guide](https://guides.rubyonrails.org/).

- [PostgreSQL](https://www.postgresql.org/) installed and running

(back to top)

##

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
https://github.com/baqar-abbas/recipe-app-capstone.git
```

(back to top)

### Install

Install this project with:

```sh
bundle install
```

(back to top)

### Usage

To run the project, execute the following command:

```sh
rails server
```

(back to top)

### Run tests

To run tests, run the following command:

```sh
rspec spec
```

(back to top)

## 👥 Authors

👤 **Abdul Ali Noori**

- GitHub: [@ab-noori](https://github.com/ab-noori)
- Twitter: [@AbdulAliNoori4](https://twitter.com/AbdulAliNoori4)
- LinkedIn: [abdulali-noori](https://www.linkedin.com/in/abdulali-noori)

👤 **Baqar Abbas**

- GitHub: [@Baqar](https://github.com/baqar-abbas)
- Twitter: [@BaqarAbbas9](https://twitter.com/BaqarAbbas9)
- LinkedIn: [Baqar Abbas](https://www.linkedin.com/in/baqar-abbas/)

(back to top)

## 🔭 Future Features
- [ ] **[Inventories list]**
- [ ] **[Inventory details]**
- [ ] **[Recipe details]**
- [ ] **[Inventory shopping list]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/baqar-abbas/recipe-app-capstone/issues/new).

(back to top)

## ⭐️ Show your support

If you like this project, give it a star.

(back to top)

## 🙏 Acknowledgments

First, I would like to thank Microverse and my coding partners.

(back to top)

## 📝 License

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

(back to top)