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

https://github.com/solobarine/recipes


https://github.com/solobarine/recipes

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

          


Recipes


# 📗 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)
- [📝 License](#license)

# 📖 Recipes

The Recipe keeps track of all your recipes and foods. You can save ingredients, view and share your recipes with other users and also generates a shopping list'

## 🛠 Built With

### Tech Stack

Language and FrameWork

Database Used

### Key Features

- **Ruby On Rails**
- **CanCan**
- **Devise**

(back to top)

## 💻 Getting Started

To get a local copy of this project and run it in your computer, follow these steps.

### Prerequisites

In order to run this project you need:
- Ruby
- Nodejs

### Setup

To get a local copy up and running follow these simple example steps.

Clone this repository in the desired folder:
```
cd my-folder
git clone https://github.com/solobarine/recipes.git
```

### Install

To install this project:
```
cd recipes
code .
bundle install
```

### Usage

To run the project, execute the following command:

```
rails server
```

### Run Tests

To setup rspec, run the following:

```
rails generate rspec:install
```

To run the project tests, execute the following command:

```
rspec
```

(back to top)

## 👥 Author

👤 **Solomon Barine Akpuru**

- GitHub: [@solobarine](https://github.com/solobarine)
- LinkedIn: [solomon-akpuru](https://www.linkedin.com/in/solomon-akpuru)

(back to top)

## 🔭 Future Features

- [ ] **Deployment.**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 📝 License

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

(back to top)