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

https://github.com/tanveerisonline/rails_recipe_app

[Recipe App] is a blog-based application build using the Ruby on Rails framework, that lets you create a user, log in, create and share recipes with diverse food and ingredients. The application is built in a way that you can only create a recipe and add food to your food list.
https://github.com/tanveerisonline/rails_recipe_app

css gitflow html rspec rubocop ruby ruby-on-rails

Last synced: 2 days ago
JSON representation

[Recipe App] is a blog-based application build using the Ruby on Rails framework, that lets you create a user, log in, create and share recipes with diverse food and ingredients. The application is built in a way that you can only create a recipe and add food to your food list.

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]** is a blog-based application build using the `Ruby on Rails` framework, that lets you create a user, log in, create and share recipes with diverse food and ingredients. The application is built in a way that you can only create a recipe and add food to your food list if you are logged into the site. Otherwise, you will only be able to see the public recipes.

You can navigate the pages using the Nav Bar. The Nav Bar has routes to different views depending on if you are logged in or not. The following links can be found there:

- Public recipes.
- My recipes.
- My foods.
- Shopping details.

>based on the ERD diagram

## 🛠 Built With

### Tech Stack

Server

Database

### Key Features

- **[Add Food]**
- **[Add Recipe]**
- **[Generate Shopping List]**

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

>To have installed ruby on your computer
>To have installed rails

```sh
gem install rails
```

### Setup

Clone this repository to your desired folder:

```sh
git clone https://github.com/george827/Recipe-app.git

```

### Install

Install this project with:

```sh
cd Recipe-app
rails db:create
rails db:migrate
```

### 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

👤 **George Kinyanjui**

- GitHub: [@george827](https://github.com/george827)
- Twitter: [George Kinyanjui](https://twitter.com/geok8376)
- LinkedIn: [George Kinyanjui](https://www.linkedin.com/in/georgekinyanjui/)

👤 **Tanveer Ahmad**

- GitHub: [@tanveerisonline](https://github.com/tanveerisonline)
- Twitter: [Tanveer Ahmad](https://twitter.com/Tanveer98589023)
- LinkedIn: [Tanveer Ahmad](https://www.linkedin.com/in/tanveer-ahmad-899462211/)

(back to top)

## 🔭 Future Features

- [ ] **[Api end points]**
- [ ] **[Add inventory]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project you can give it a star ⭐️

(back to top)

## 🙏 Acknowledgments

I would like to thank microverse for providing all the resources to buld this

(back to top)

## 📝 License

This project is [MIT](https://github.com/tanveerisonline/Rails_Recipe_App/blob/main/LICENSE) licensed.

(back to top)