https://github.com/melashu/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.
https://github.com/melashu/sleepover-api
post postgresql ruby rubyonrails
Last synced: 6 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/melashu/sleepover-api
- Owner: melashu
- License: mit
- Created: 2023-01-18T12:52:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-06T06:24:38.000Z (about 3 years ago)
- Last Synced: 2025-01-24T22:49:34.323Z (over 1 year ago)
- Topics: post, postgresql, ruby, rubyonrails
- Language: Ruby
- Homepage:
- Size: 156 KB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🔖 Learning objectives](#learning-objectives)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
>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 📄
- [x] Here is the [Frontend Project Link](https://github.com/melashu/Hotel-room-reservation-front)👈
- [x] Here is the [Api Documentation Link](https://sleepoverapi.onrender.com/api-docs/index.html)
BackEnd
Test
Database
- **[Delploy on render]** - Delploy on heroku
- **[Improve security]** - Improve security
- **[ Add testes ]** - Add testes
- [Comming soon]()
- [Coming soon]()
To get a local copy up and running, follow these steps.
### Prerequisites
- [x] A web browser like Google Chrome.
- [x] 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:
```bash command
` $ rails server`
```
### Run tests
To run tests, run the following command:
```bash command
$ rspec
```
👤 **Benjamin kisenge**
- GitHub: [@benjamin kisenge](https://github.com/iambenkis)
- Twitter: [@benjamin kisenge](https://twitter.com/iambenkis)
- LinkedIn: [benjamin kisenge](https://www.linkedin.com/in/ben-kisenge/)
👤 **Meshu Amare**
- GitHub: [@melashu](https://github.com/melashu)
- Twitter: [@meshu102](https://twitter.com/meshu102)
- LinkedIn: [Melashu Amare](https://www.linkedin.com/in/melashu-amare/)
👤 **Abigiya Tadesse**
- GitHub: [@githubhandle](https://github.com/AbigiyaTY)
- Twitter: [@twitterhandle](https://twitter.com/AbigiyaTY)
- LinkedIn: [@LinkedIn](https://www.linkedin.com/in/AbigiyaTY)
👤 **Lawrence Addai Kusi**
- GitHub: [@Githubhandle](https://github.com/kusiLaw)
- Twitter: [@Twitterhandle](https://twitter.com/kusilaw)
- Linkedin: [Linkedin](https://www.linkedin.com/in/lawrence-kusi-55a662104)
👤 **Mo'athal S. Kachi**
- GitHub: [@githubhandle](https://github.com/Moathal)
- Twitter: [@twitterhandle](https://twitter.com/mo_athal)
- LinkedIn: [LinkedIn](https://linkedin.com/in/moathalkachi)
- [ ] **[Delploy on heroku]** - Delploy on heroku
- [ ] **[Improve security]** - Improve security
- [ ] **[ Add testes ]** - Add testes
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](ttps://github.com/melashu/Hotel-room-reservation-front/issues).
If you like this project give as a star! ⭐️
- [Microverse](https://www.microverse.org/)
- Coding Partners
- Code Reviewers
- **[How I can run this project?]**
- [After cloning repository, run rails server.]
## 📝 License
This project is [MIT](./LICENSE) licensed.