/bidding-realtime

Web Socket Backend for the auction which took place in Reverse Coding 2020.

Primary LanguageTypeScriptMIT LicenseMIT

Dependencies Issues Size LinkedIn License


Logo

Auction Web Socket Backend

Server deals with realtime socket transfers used for the auction rounds. It supplies bid history and bidding functionality.

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. License
  5. Contact
  6. Acknowledgements

About The Project

The project was created to provide realtime functionality for the auction in ACM-VIT's Reverse Coding event in 2020.

The server allows bids to take place on questions and returns success and error responses with a live bid history.

Built With

Getting Started

The project runs on Node.js utilizing npm as the package manager.

Prerequisites

Make sure you have node.js version 8 or above to run this project.

Installation

  1. Clone the repository

    git clone https://github.com/HelixW/bidding-realtime.git

  2. Install NPM packages

    npm install

  3. Create a .env file using the configuration in .env.example

    touch .env

  4. Start the development server

    npm run watch

Usage

The server serves a html template at / for testing which offers full functionality. Use a the template to place bids.

When developing client side code for the server, use the socket.io-client package for easy configuration.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Shreyas K. - Linkedin - Business Email

Project Link - https://github.com/HelixW/bidding-realtime

Acknowledgements