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

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

Recipe App is a app containing data about foods, recipes, and shopping lists.
https://github.com/javieraybar/recipe-app

api postgresql rails ruby

Last synced: about 2 months ago
JSON representation

Recipe App is a app containing data about foods, recipes, and shopping lists.

Awesome Lists containing this project

README

          

Blog Ruby

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 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)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 About the Project

**Recipe App** is a app containing data about foods, recipes, and shopping lists.

## 🛠 Built With

### Tech Stack

Client

Databases

### Key Features

- **Contains data about users**
- **Contains data about posts**

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

- An IDE (ex: VS Code)
- Github account

### Setup

Clone this repository to your desired folder:

```sh
cd project-folder
git clone https://github.com/JavierAybar/Recipe-app.git
```

### Install

Install this project with webpack:

```sh
cd project-folder
bundle install
rails db:setup
```

### Usage

To run the project, execute the following command:

```sh
rails server
```

### Run tests

To run tests, run the following command:

```sh
rspec spec
```

### Compile Tailwind CSS:

```sh
rails tailwindcss:build
```

### Deployment

You can deploy this project using GitPages:

- Go to github.com
- Create a new repository
- Add all website files in the new repository
- Go to Settings/Pages
- Go to branch and change from 'none' to 'main'
- Click Save

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://recipe-app-t2ko.onrender.com)

(back to top)

## 👥 Authors

👤 **Javier Aybar**

- GitHub: [@JavierAybar](https://github.com/JavierAybar)
- LinkedIn: [@JavierAybar](https://www.linkedin.com/in/javier-aybar-932376274/)

👤 **Soban Syeed**

- GitHub: [@SnakyMz](https://github.com/SnakyMz)
- Twitter: [@SobanSyeed](https://twitter.com/SobanSyeed)
- LinkedIn: [Soban Syeed](https://www.linkedin.com/in/soban-syeed-82985b241/)

(back to top)

## 🔭 Future Features

- [ ] **More data**
- [ ] **More query**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project and wish to collaborate. Please contact us.

(back to top)

## 🙏 Acknowledgments

- Thank you Microverse.

(back to top)

## ❓ FAQ

- **Is it responsive?**

- Yes, works both on mobile and desktop.

(back to top)

## 📝 License

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

(back to top)