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

https://github.com/ivonnebenitesrodriguez/finalgroupcapstone-backend

This webapp provides functionality to create, read, and destroy data related to hotels. It will serve as the server-side component responsible for handling requests and managing the database.
https://github.com/ivonnebenitesrodriguez/finalgroupcapstone-backend

gemfile kanban-board postgresql-database rails rakefile rubocop ruby swagger vercel-deployment

Last synced: about 1 year ago
JSON representation

This webapp provides functionality to create, read, and destroy data related to hotels. It will serve as the server-side component responsible for handling requests and managing the database.

Awesome Lists containing this project

README

          

# 🏩 finalGroupCapstone-backend

Book an appointment | Hotels



## Kanban board
- [Kanban board Project link](https://github.com/users/IvonneBenitesRodriguez/projects/19/views/1)

### Initial State of Kanban board

### Complete State of Kanban board

Our group remained the same of 2 team members throughout the whole project.

# πŸ“— Table of Contents

- [🏩 finalGroupCapstone-backend](#-finalgroupcapstone-backend)
- [πŸ“— Table of Contents](#-table-of-contents)
- [πŸ“– Book a Hotel ](#-book-a-hotel-)
- [πŸ›  Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [πŸ’» Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [πŸ’Ύ Database](#-database)
- [Usage](#usage)
- [Run tests](#run-tests)
- [πŸ‘₯ Authors ](#-authors-)
- [πŸ”­ Future Features ](#-future-features-)
- [🀝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [πŸ™ Acknowledgments ](#-acknowledgments-)
- [πŸ“ License ](#-license-)

# πŸ“– Book a Hotel

> The Book a Hotel 🏩, our API will provide functionality to create, read, and destroy data related to hotels. It will serve as the server-side component responsible for handling requests and managing the database. The React client will interact with this backend to perform actions such as creating new hotels and reservations, see the hotel details, and removing hotels from the system.

## πŸ›  Visit our deployed Link:
https://book-an-appointment-cmm0.onrender.com/

## πŸ›  Visit our FrontEnd:
https://github.com/IvonneBenitesRodriguez/finalGroupCapstone-frontend/pull/7

API documentation:
[API DOC](https://book-an-appointment-cmm0.onrender.com/api-docs/v1/swagger.yaml)

## πŸ›  Built With

### Tech Stack

Client

Server




Database

### Key Features

- **Data Model**

(back to top)

(back to top)

## πŸ’» Getting Started

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

### Prerequisites

> You need the following tools be installed in your computer:

> - [Rails](https://guides.rubyonrails.org/)
> - [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)
> - [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)

### Setup

Clone this repository to your desired folder:

```sh
cd my-prefered-folder

git clone https://github.com/IvonneBenitesRodriguez/finalGroupCapstone-backend.git

```

### Install

Install this project with:

```sh
cd finalGroupCapstone-backend

bundle
```

### πŸ’Ύ Database

Create the databases, run migrations, and populate it with seed data:

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

### Usage

To run the project run the following commands:

```sh
rails s
```

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Ivonne Benites**

- 🌷GitHub: [@githubhandle](https://github.com/IvonneBenitesRodriguez)
- 🌷Twitter: [@twitterhandle](https://twitter.com/IvonneBenitesR)
- 🌷LinkedIn: [LinkedIn](https://www.linkedin.com/in/ivonnebenites/)

πŸ‘€ **Gilbert Dushimimana Happi**

- Github: [Gilbert Happi Dushimimana](https://github.com/gilberthappi)
- X: [Gilbert Happi Dushimimana](https://twitter.com/DushimimanaGil3)
- LinkedIn: [Gilbert Happi Dushimimana](https://www.linkedin.com/in/dushimimana-gilbert-happi-997b2a262/)

(back to top)

## πŸ”­ Future Features

- [ ] **Complete the CRUD for places and reservations.**

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/IvonneBenitesRodriguez/finalGroupCapstone-backend/issues).

(back to top)

## ⭐️ Show your support

If you like this project please give it a star 😁🌟✨

(back to top)

## πŸ™ Acknowledgments

We thank to [Murat Korkmaz](https://www.behance.net/muratk) for the marvelous [design](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign).

(back to top)

## πŸ“ License

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

(back to top)