📗 Table of Contents

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

📖 [Members-Only]

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

This is part of the Forms Project in The Odin Project’s Ruby on Rails Curriculum. Find it at "http://www.theodinproject.com”. In which we are using devise to implement authentication

🛠 Built With

• Ruby on Rails (RoR)

Tech Stack

BackEnd

• Rails

Test

• RSPEC

Database

• PostgreSQL

Key Features

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

(back to top)

🚀 Live Version

• Comming soon

(back to top)

🚀 Presenation video

• Coming soon

(back to top)

💻 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

(back to top)

👥 Authors

👤 Mo'athal S. Kachi

• GitHub: @githubhandle
• LinkedIn: LinkedIn

🔭 Future Features

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

(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 give as a star! ⭐️

(back to top)

🙏 Acknowledgments

• Microverse
• Coding Partners
• Code Reviewers

❓ FAQ

• [How I can run this project?]

  • [After cloning repository, run rails server.]

(back to top)

📝 License

This project is MIT licensed.