Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/preciousakams/hotel-room
SuiteUp is a simulation of a hotel room reservation system. It enables users to make room reservations. It also allows users to see all of their reservations in a list format, delete a room only if it is empty, and all visitors can see unreserved rooms.
https://github.com/preciousakams/hotel-room
rails ruby
Last synced: 9 days ago
JSON representation
SuiteUp is a simulation of a hotel room reservation system. It enables users to make room reservations. It also allows users to see all of their reservations in a list format, delete a room only if it is empty, and all visitors can see unreserved rooms.
- Host: GitHub
- URL: https://github.com/preciousakams/hotel-room
- Owner: preciousakams
- License: mit
- Created: 2022-09-29T20:54:01.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-14T17:20:42.000Z (almost 2 years ago)
- Last Synced: 2024-10-12T09:51:16.471Z (about 1 month ago)
- Topics: rails, ruby
- Language: Ruby
- Homepage:
- Size: 99.6 KB
- Stars: 2
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## SuiteUp
> SuiteUp is a simulation of a hotel room reservation system.
It enables users to make room reservations.
It also allows users to see all of their reservations in a list format, delete a room only if it is empty, and all visitors can see unreserved rooms. You can check the source code for frontend [here](https://github.com/felixodette/hotel-room-frontend).
## Backend Schema
## Live Demo
- [Front End](https://hotel-room-frontend.vercel.app/)
- [Back End API](https://afternoon-fjord-27064.herokuapp.com/)
## Built With
### Backend
- [x] Programming Language: [Ruby](https://www.ruby-lang.org/en/)
- [x] Framework: [Ruby on Rails](https://rubyonrails.org/)
- [x] Linter: [Rubocop](https://rubocop.org/)
- [x] Code Editor: [VS Code](https://code.visualstudio.com/)
- [x] Database: [PostgreSQL](https://www.postgresql.org/)
- [x] Testing Framework: [RSpec](https://rspec.info/)
- [x] API Documentation: [Swagger](https://swagger.io/)
### Frontend
- [x] Programming Language: [JavaScript](https://www.javascript.com/)
- [x] Framework: [React](https://reactjs.org/)
- [x] Library: [Redux](https://redux.js.org/)
- [x] Linter: [ESLint](https://eslint.org/)
- [x] Code Editor: [VS Code](https://code.visualstudio.com/)
- [x] Testing Framework: [Jest](https://jestjs.io/)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Install
In the terminal, go to your file directory and run this command.
```
$ git clone https://github.com/kamzzy/Hotel-Room.git
```
### Usage
Go to the app directory
```
$ cd Hotel-Room
```
Run the server
```
$ rails server
```
You can check the linter issues and fix them
```
$ rubocop -A
```
### Setup
Install Gems
```
$ bundle install
```
Create the database
```
$ rails db:create
```
Migrate database schema
```
$ rails db:migrate
```
Seed the database
```
$ rails db:seed
```
### 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
```
### API Documentation
You can find the API documentation by
```
$ rails server
```
Then go to this link: [http://localhost:3000/api-docs/index.html](http://localhost:3000/api-docs/index.html)
### Prerequisites
- [x] A web browser like [Google Chrome](https://www.google.com/chrome/).
- [x] A code editor like [Visual Studio Code](https://code.visualstudio.com/).
- [x] A terminal to run the code.
- [x] [Ruby](https://www.ruby-lang.org/en/) installed on your computer.
- [x] [Rails](https://rubyonrails.org/) installed on your computer.
You can check if Git is installed by running the following command in the terminal.
```
$ git --version
```
Likewise for Ruby installation.
```
$ ruby --version && irb
```
To install rails, in the terminal kindly run this command
```
$ gem install rails
```
## Authors
👤 **Ahmad Zamir Yousufi** 
- GitHub: [@ahzamir](https://github.com/ahzamir).
- Twitter: [@YousufiZamir](https://twitter.com/YousufiZamir)
- LinkedIn: [ahzamir](https://www.linkedin.com/in/ahzamir/)
👤 **Huseyin Biyik**
- GitHub: [@huseyinbiyik](https://github.com/huseyinbiyik).
- Twitter: [@huseyin__biyik](https://twitter.com/huseyin__biyik)
- LinkedIn: [Huseyin_biyik](http://www.linkedin.com/in/tahahuseyinbiyik/)
👤 **Precious Akams**
- GitHub: [@kamzzy](https://github.com/kamzzy).
- Twitter: [@precious_akams](https://twitter.com/precious_akams)
- LinkedIn: [Onyeagoziri_Akams](https://www.linkedin.com/in/Onyeagoziri_Akams/)
👤 **Felix Odete**
- GitHub: [@felixodette](https://github.com/felixodette).
- Twitter: [@Odette3000](https://twitter.com/Odette3000)
- LinkedIn: [Felix_Odete](https://www.linkedin.com/in/Felix_Odete/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/kamzzy/Hotel-Room/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- [Microverse](https://www.microverse.org/)
- Code Reviewers
- Coding Partners
## 📝 License
This project is [MIT](./MIT.md) licensed.
