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

https://github.com/thoth1111/rails-group-capstone


https://github.com/thoth1111/rails-group-capstone

Last synced: 11 months ago
JSON representation

Awesome Lists containing this project

README

          


Rails Group Capstone


# 📗 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)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 Rails Group Capstone

Rails group capstone is a group project to create web based app that conntains user, recipe and recipe food information. A registered user can add foods, create recipes and link foods to recipes.

## 🛠 Built With

### Tech Stack

- Ruby on Rails
- PostgreSQL
- RSpec

### Key Features

- **CRUD Operations**

- **Authentication**

- **Authorization**

(back to top)

### 🚀 Live Demo
Access the development [demo](https://ror-group-capstone.onrender.com)

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

### Setup

Clone the repo and open terminal in the project root directory

### Install

Install this project with:

```sh
bundle install
```

And Create `.env` file in the root directory add the configurations.
You can use the `.env.example` file as a template.

### Usage

To run the project, execute the following command:

```sh
rails s
```

(back to top)

## 👥 Authors

**Wai Yan Phyo**

- Github: [@oyhpnayiaw](https://github.com/oyhpnayiaw)
- Twitter: [@oyhpnayiaw](https://twitter.com/oyhpnayiaw)
- LinkedIn: [@oyhpnayiaw](https://linkedin.com/in/oyhpnayiaw)

**Alwyn Androvelle**

- Github: [@Thoth1111](https://github.com/Thoth1111)
- Twitter: [@androvelle](https://twitter.com/androvelle)
- LinkedIn: [@Alwyn](https://linkedin.com/in/alwyn-androvelle-simiyu)

(back to top)

## 🔭 Future Features

- [ ] **Update Methods**

- [ ] **User profile**

(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 or find it useful, please consider giving it a ⭐️. Thanks!

(back to top)

## 🙏 Acknowledgments

Multiple resources online and Microverse.

(back to top)

## 📝 License

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

(back to top)