Skip to content

README.md

Latest commit

 

History

History
85 lines (58 loc) · 2.69 KB

README.md

File metadata and controls

85 lines (58 loc) · 2.69 KB

API for roomz.com

LinkedIn


About The Project

This is a simple hotel rooms booking app. This API can be used for the client side to get information about the hotels & to book the rooms as well as used for the admin purpose to get information about all the users/hotels/rooms/bookings etc...

Features :

  • Sign up / Sign in
    A user can create an account as a CUSTOMER and sign into the account to use the website. And an admin can login in to the predefined admin account.

  • An user can search for the hotels based on the city/type of accomodation/ price range and book the rooms in the selected hotel for the selected date.

  • An admin can perform CRUD operations on users/hotels/rooms/bookings.

Built with :

  • MongoDB

  • Express.js

  • Node.js



Installation


  1. Run the following command in the terminal to clone the repository

    git clone https://github.com/shetty-nithin/roomz.com-API.git

  2. Go inside the root folder

  3. Install NPM packages

    npm install

  4. Inside the root folder create one more file with name ".env" and mention the port as below

     MONGO_DB_URL = mongodb://localhost:27017/roomz
 PORT = 8080
 JWT_SECRET_KEY = "<some string>"
 ACCESS_TOKEN_TIME = 1200

  5. Run the server

    npm start

Demo

Customer Interface

customer.Interface.mp4

Admin Interface

admin.Interface.mp4