📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Sleep over app

This is an app that helps you to book an hotel's room from all over the world.

🛠 Built With

Tech Stack

Here are List of technologies used on this project

Languages

• Ruby
• JavaScript
• HTML
• CSS

Frameworks

• React
• Redux
• Ruby on Rails

Database

• PostgreSQL

Linters

• Rubocop
• Stylelint

Test library

• Rspec
• Jest

Key Features

• Book Rooms
• Admninistration of rooms
• See a list of Hotel's rooms

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• Npm
• Git
• Broswer to Display
• IDE to run and edit the code

Setup

Clone this repository to your desired folder for frontend:

  git clone https://github.com/melashu/Hotel-room-reservation-front.git

change directory to cloned folder

  cd Hotel-room-reservation-front

Clone this repository to your desired folder for backend:

  git clone https://github.com/melashu/hotel-room-reservation.git

change directory to cloned folder

  cd hotel-room-reservation

Install (In your frontend project terminal)

Install project dependecies with:

  npm install

Install (In your backend project terminal)

Install project dependecies with:

  bundler install

Usage (In backend)

To run the project, execute the following command:

 rails s

Usage (In frontend)

To run the project, execute the following command:

  npm start

• After running npm start, open your browser and enter this address http://localhost:3000/
• Register as regular user using signup link.
• To login as an admin, first run as rails db:seedin your backend terminal
• Then enter the following

Email: admin@gmail.com
Password: 123456789

• Congratulations! your're running Hotel-room-reservation-front

(back to top)

👥 Authors

👤 Benjamin kisenge

• GitHub: @benjamin kisenge
• Twitter: @benjamin kisenge
• LinkedIn: benjamin kisenge

👤 Meshu Amare

• GitHub: @melashu
• Twitter: @meshu102
• LinkedIn: Melashu Amare

👤 Abigiya Tadesse

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: @LinkedIn

👤 Lawrence Addai Kusi

• GitHub: @Githubhandle
• Twitter: @Twitterhandle
• Linkedin: Linkedin

👤 Mo'athal S. Kachi

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

These features will be added in future updates. ⬇️⬇️

• Online payment
• Chat in the app

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like👍🏽 this project, give the repository a star ⭐

(back to top)

🙏 Acknowledgments

• I would like to thank the Microverse community

• Specails thanks to Murat Korkmaz on Behance for designing the template

📝 License

This project is MIT licensed.

(back to top)