/Marriott-Reservation-Backend

MARRIOT HOTEL RESERVATIONS APP is an app that allows users to book a room in a marriot hotel. Users can see a list of available rooms, and can book a room for a specific date range. Users can also see their reservations and delete them.

Primary LanguageRubyMIT LicenseMIT

logo

MARRIOTT HOTEL RESERVATIONS APP


# 📗 Table of Contents

📖 MARRIOTT HOTEL RESERVATIONS APP

MARRIOTT HOTEL RESERVATIONS APP is an app that allows users to book a room in a Marriott hotel. Users can see a list of available rooms, and can book a room for a specific date range. Users can also see their reservations and delete them.

🛠 Built With

Tech Stack

Editor
Backend
Frontend
Database
Authentication
Testing
API Documentation

Key Features


  • Users can register and log in
  • Users must be logged-in to use the app
  • Users can see a home page with the available rooms
  • Users can book a room
  • When the user selects a specific room, a details page with its full description is shown
  • In the details page, the user can book a room with the "Reserve" button
  • When the user clicks "Add Room" in the navigation panel, a form for adding a new room is displayed
  • Users can see their reservations
  • Users can delete a rooom

(back to top)

🚀 Live Demo

(back to top)

Front-end Repository

Kanban Board

We Used Kanban Board to organize our work and we are a group of 4 peoples

Before Implementing the Project

Front-End Kanban-Board

Back-End Kanban Board

After Implementing the Project

Front End Kanban Board

Back-End Kanban Board

💻 Getting Started

Prerequisites

In order to run this project you need:

  • A code editor of your preference, for example VSCODE or Atom
  • Ruby 3.1.2
  • Rails 7.0.4 or newer
  • GIT
  • YARN or - NPM
  • PostgreSQL

Setup

Clone this repositories to your desired folder:

## Backend
git clone https://github.com/Miliyonayalew/Marriott-Reservation-Backend

## Frontend
git clone https://github.com/OscarFMdev/Marriott-Reservation-Frontend

Setup the Backend

cd ./Marriott-Reservation-Backend

Install the gems and dependencies:

bundle install

Make sure you can connect to postgresql and create the database:

rails db:create
rails db:migrate
rails db:seed

And delete the credential and master key inside the config folder
then generate new one with the following command

`EDITOR="code --wait" bin/rails credentials:edit`

Then run the following command to start the server
rails s

API Documentation

Setup the Frontend

cd ./Marriott-Reservation-Frontend

If the user doesn't have yarn, install it:

npm install --global yarn

Install the gems and dependencies:

yarn install

Usage

To run the Backend, execute the following command:

rails server

To run the Frontend, execute the following command:

yarn dev

Run tests

To run tests in the Backend, run the following command:

rspec

To run tests in the Frontend, run the following command:

yarn test

(back to top)

👥 Authors

Danys Linares

Oscar Fernandez

Miliyon Ayalew

Hans Zizold

(back to top)

🔭 Future Features

  • Only admin users can add and delete rooms
  • Add availability of rooms
  • Add a search bar to search for rooms

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

  • My loving family 😊
  • My partners from Microverse
  • Inspiration, Dedication

(back to top)

Copyrights

Original design idea by Murat Korkmaz, under Creative Commons License.

📝 License

This project is MIT licensed.

(back to top)