Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/felipe-perez-ferraro/final_capstone_back


https://github.com/felipe-perez-ferraro/final_capstone_back

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        


Reserve Boats

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Final Capstone Project Backend ](#-final-capstone-project-backend-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Front End Part ](#-front-end-part-)
- [🚀 Kanban Board ](#-kanban-board-)
- [🚀 ERD ](#-erd-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Final Capstone Project Backend

**Reserve Boats** is a website made in Ruby on Rails + Postgresql and React + React Router + Redux where after signing up and logging in, you can book a ride in a boat, add a new boat or delete it!

It's an API only RoR project.

## 🛠 Built With

### Tech Stack

Client

Server

Database

### Key Features

- **API only RoR**
- **Postgresql database**

(back to top)

## 🚀 Front End Part

The site has 2 separate repositories, this is the Frontend repository.

Link to the [Front End Repository](https://github.com/Felipe-Perez-Ferraro/final_capstone_front)

(back to top)

## 🚀 Kanban Board

Link for the [Kanban Board](https://github.com/users/Felipe-Perez-Ferraro/projects/2/views/1)

The Initial state of the Kanban Board:

![Kanban Board - Initial state](./kanbanboard.png)

The 3 team members:

- [Ulises Cappa](https://github.com/ulises2607)
- [Hajnalka Oltyan](https://github.com/hajnaloltyan)
- [Felipe Perez Ferraro](https://github.com/Felipe-Perez-Ferraro)

(back to top)

## 🚀 ERD

![ERD](./ERD.png)

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

```sh
gem install rails
```

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/Felipe-Perez-Ferraro/final_capstone_back
```

### Install

Install this project with:

```sh
cd my-project
bundle install
```

### Usage

To run the project, execute the following command:

```sh
rails db:create
rails db:migrate
rails db:seed
rails server
```

Link for the API Documentation: http://127.0.0.1:3001/api-docs/index.html

(back to top)

## 👥 Authors

👤 **Felipe Perez Ferraro**

- GitHub: [@githubhandle](https://github.com/Felipe-Perez-Ferraro)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/felipe-perez-ferraro-6b9358218/)

👤 **Ulises Cappa**

- GitHub: [@ulises2607](https://github.com/ulises2607)
- LinkedIn: [Cesar Ulises Cappa Subelza](https://www.linkedin.com/in/cesar-ulises-cappa-subelza/)

👤 **Hajnalka Oltyan**

- GitHub: [@hajnaloltyan](https://github.com/hajnaloltyan)
- LinkedIn: [Hajnal Oltyan](https://www.linkedin.com/in/hajnaloltyan)

(back to top)

## 🔭 Future Features

- [ ] **Edit and Delete a Reservation**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Felipe-Perez-Ferraro/final_capstone_back/issues).

(back to top)

## ⭐️ Show your support

If you like this project please share with your friends and family!

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for teach me and support me to do this.

(back to top)

## 📝 License

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

(back to top)