Code Monkey home page Code Monkey logo

bidding-realtime's Introduction

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

bidding-realtime's People

Contributors

helixw avatar dependabot[bot] avatar madrigal1 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.