huseyinbiyik/suiteup-api

SuiteUp is a project that simulates a hotel room booking system. It allows users to add, delete, book a room. API was built with Ruby on Rails and the front-end with React.js

SuiteUp

Hotel Room is a project that simulates a hotel room booking system. It allows users to book a room for one night. It also allows users to see the list of all booked rooms on that day and see a list of rooms that are not booked yet. You can check the source code for frontend here.

Backend Schema

Live Demo

• Front End
• Back End API

Built With

Backend

• Programming Language: Ruby
• Framework: Ruby on Rails
• Linter: Rubocop
• Code Editor: VS Code
• Database: PostgreSQL
• Testing Framework: RSpec
• API Documentation: Swagger

Frontend

• Programming Language: JavaScript
• Framework: React
• Library: Redux
• Linter: ESLint
• Code Editor: VS Code
• Testing Framework: Jest

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

Prerequisites

• A web browser like Google Chrome.
• A code editor like Visual Studio Code.
• A terminal to run the code.
• Ruby installed on your computer.
• Rails 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.
• Twitter: @YousufiZamir
• LinkedIn: ahzamir

👤 Huseyin Biyik

• GitHub: @huseyinbiyik.
• Twitter: @huseyin__biyik
• LinkedIn: Huseyin_biyik

👤 Precious Akams

• GitHub: @kamzzy.
• Twitter: @precious_akams
• LinkedIn: Onyeagoziri_Akams

👤 Felix Odete

• GitHub: @felixodette.
• Twitter: @Odette3000
• LinkedIn: Felix_Odete

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Microverse
• Code Reviewers
• Coding Partners

📝 License

This project is MIT licensed.