Git Product home page Git Product logo

hotel-booking's Introduction

Hotel Booking API on Rails 5, Postgresql

Features

CMS for admin for CRUD of rooms API

  1. List rooms availability for all, day and range
  2. Book rooms for multiple quantity and days
  3. Cancel/Edit bookings

How to use - locally

  1. rails db:setup
  2. rails db:seed (adds admin, user, and availabilities data)
  3. rails s

Front end usage guide

  1. Postico Post request for login format Body, raw, must be json type.
{"auth": {"email": "[email protected]", "password" : "test123"}}

User: [email protected] test123

  1. Sign up:
{"user":{"email":"[email protected]", "password_digest":"tester123"}}
  1. Send booking creation data
booking[booking_day]:"2017-12-24"
booking[duration]:4
booking[quantity]:5
booking[room_id]:2

API Endpoints

  GET  / => rooms#index
  Show all rooms - auth not required in test

  POST /user_token
  Sign in as user and get token

  GET /availabilities
  Show all room availabilities

  GET /availabilities/2017-12-23
  Show room availabilities for one day

  GET /availabilities/range/:dates
  e.g. /availabilities/range/2017-12-23&2017-12-24
  Show room availabilities in range
  Index bookings:
  Get /bookings

  Show booking
  GET /bookings/:id
***USER TOKEN MUST BE SET IN HEADER ***
  To Create Bookings:
  POST /bookings
  Header:
  Authorization with Bearer token,
  Accept: application/json, text/plain, */*,
  Content-Type:[{"key":"Content-Type","value":"application/json","description":"","enabled":true}]
  Form Body: booking[booking_day], booking[duration], booking[quantity], booking[room_id]  

  Update booking
  PATCH/PUT /bookings/:id
  Same as POST; only use fields to be updated

  Delete booking
  Delete /bookings/:id
  Set Header to be same as POST

Non-authenticated actions are Read-only

hotel-booking's People

Contributors

nikitas89 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.