The Hotel Booking

📗 Table of Contents

• 📗 Table of Contents
• 📖 Hotel Booking
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
    • Deployment
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Hotel Booking

The Hotel Booking is hotel booking application.

🛠 Built With

• ✅ React
• ✅ React-Redux
• ✅ Ruby
• ✅ Ruby on Rails
• ✅ Postgresql
• ✅ Linters

Tech Stack

Language

• Ruby
• React

Key Features

• 🔰 Authenticate users
• 🔰 Read all hotels
• 🔰 Read hotel description
• 🔰 Reserve a hotel
• 🔰 Choose a date/city to reserve
• 🔰 Admin can add/remove hotel

(back to top)

💻 Getting Started

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

1. Download or clone this repostory.
2. Provide a modern web browser.

API Docs:

API docs are created and are accessible by following steps:

Run below command in the terminal

rails s

Paste this Link below in the Browser

http://localhost:4000/api-docs/index.html

Prerequisites

In order to run this project you need:

• ✔ Ruby installed in your machine. you can download it from here
• ✔ IDE or a code editor installed in your machine.
• ✔ IRB.
• ✔ Get Postgresql up and running. you can download it from here.
• ✔ Git installed in your machine.
• ✔ Sign in or sign up to your Github account.
• ✔ A professional editer such as VS Code.
• ✔ An Updated web browser such as Google Chrome, you can download it from here.

Setup

• Clone this repository to your desired folder:

• Run this command in your command line interface:

  cd [YOUR FOLDER]
  git https://github.com/paulshaun-kdtk/Hotel-Booking.git
  cd Hotel-Booking
  bundle install
  code .

• Update the database.yml with your database credentials under the development section

Usage

• To run the Backend of project, execute the following command:

    bundle install
    rails db:create
    rails db:migrate
    rails s

• In case you find any error in starting backend that might be due to credentials.yml file so delete that file and then run the commands below:

    --open your gitbash terminal--
    EDITOR="code --wait" rails credentials:edit
    --then close your credentials file--
    bundle install
    rails db:create
    rails db:migrate
    rails s

• To run the FrontEnd of project, execute the following command:

    --open another gitbash terminal--
    cd frontend-react-app
    npm i
    npm start

Deployment

This project is deployed by the author, no permission for deployment by any other client.

Tests

• To run the tests of project, execute the following command in root folder:

    --open your gitbash terminal--
    rspec ./spec/integration
    rspec ./spec/models

(back to top)

👥 Author

👤 Muhammad Zunair khan

• GitHub: @zunairkhan811
• Twitter: @zunairkhan811
• LinkedIn: @mzunairkhan

👤 Assem Zhorabay

• GitHub: @zhorabay
• LinkedIn: @zhorabay
• Twitter: @zhorabay
• Wellfound: @zhorabay

👤 Shaun Kudzai

• GitHub: @githubhandle

👤 Obi Anthony

• GitHub: @megagig
• Twitter: @megagigsolution
• LinkedIn: Anthony Obi

👤 Mumbere Habert

• GitHub: @mumbereh
• Twitter: @mumberehabert1
• LinkedIn: Mumbere Habert

(back to top)

🔭 Future Features

• Add start/end dates
• Add share the reservation button

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, kindly drop a start ⭐️ for the repository;

(back to top)

🙏 Acknowledgments

We would like to express our heartfelt gratitude to Behance Design for the wonderful design which we used according to Creative Commons license of the design.

(back to top)

📝 License

This project is MIT licensed.

(back to top)