sleepover-API

This is an API built with Ruby on Rails, and Postgres. It is a hotel room reservation app, it enables hotel owners to register their hotel and available rooms, and see the reservations done by customers. The customer also books a hotel room from all over the world.

MIT License

Stars
7
Committers
5

📗 Table of Contents

📖 [Sleep-Over-Backend-App]

A Sleep over App developed using React for Front-End and Ruby on Rails for Back-End.

This is our Final React-Rails Capstone project in the Microverse curriculum.

Project Documentation 📄

🛠 Built With

Tech Stack

Key Features

  • [Delploy on render] - Delploy on heroku
  • [Improve security] - Improve security
  • [ Add testes ] - Add testes

🚀 Live Version

🚀 Presenation video

💻 Getting Started

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

Prerequisites

  • A web browser like Google Chrome.
  • A code editor like Visual Studio Code with Git and Ruby.

You can check if Git is installed by running the following command in the terminal.

$ git --version

Likewise for Ruby installation.

$ ruby --version && irb

Install

In the terminal, go to your file directory and run this command.

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

$ gem install bundler

$ bundle install

$ rails db:create db:migrate

Run tests

To install rspec, in the terminal kindly run this command

$ gem install rspec

To run tests, please run this command

$ rspec ./spec/#{filename}_spec.rb

Run the app

To run the app you need to run this command in the terminal


$ rails s

Usage

To run the project, execute the following command:

` $ rails server`

Run tests

To run tests, run the following command:

 $ rspec

👥 Authors

👤 Benjamin kisenge

👤 Meshu Amare

👤 Abigiya Tadesse

👤 Lawrence Addai Kusi

👤 Mo'athal S. Kachi

🔭 Future Features

  • [Delploy on heroku] - Delploy on heroku
  • [Improve security] - Improve security
  • [ Add testes ] - Add testes

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project give as a star! ⭐️

🙏 Acknowledgments

❓ FAQ

  • [How I can run this project?]

    • [After cloning repository, run rails server.]

📝 License

This project is MIT licensed.

Related Projects