Auction Backend

Server deals with feeding in of round data and all administrative actions and allotment of questions to the respective teams.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact
6. Acknowledgements

About The Project

The project was created to serve as a base for the auction in ACM-VIT's Reverse Coding event in 2020. The backend deals with serving details of the 3 auction rounds and allotment of questions to the respective teams. Another express server was created to work in conjunction to the current server to deliver real time updates for the auction.

The backend is documented with the help of Swagger and the documentation is available on /docs.

Built With

• Nest.js
• Firebase

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-backend.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 start:dev

Usage

Documentation for the restful server is available at http://localhost:<your-port>/docs.

The server uses a global /api prefix for all routes.

License

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

Contact

Shreyas K. - Linkedin - Business Email

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

Acknowledgements

• Google Cloud Platform
• Swagger
• Joi
• JSONWebToken