SubashAravindan / AavegWebsite

Website for Aaveg'19 - Inter hostel sports cum cultural fest of NIT Trichy

Aaveg

Website and app backend for Aaveg.

Developing

Built With

NodeJS, Express

Prerequisites

You need to install Node, npm and mongoDB

Setting up Dev

git clone https://github.com/SubashAravindan/AavegWebsite
cd AavegWebsite
cp config/config.example.js config/config.js
#Replace the values in config.js
npm install
npm install -g standard
npm install -g node-mongo-seeds
seed
mkdir logs && touch logs/erros.log logs/warnings.log

General Coding Advice

• Follow the coding style given below
• Maintain the project structure (routes, conrollers etc).
• Use ES6+ features to write clean code. Especially async await, template strings etc
• Update README
• Add seed data if needed
• Use the winston library for logging.

Style guide

We'll be using the standard JS coding style. Check https://standardjs.com/. Always stick to this style pls.

To check for errors, run :

standard

Most of the times, this following command will magically fix it for you :)

standard --fix

Api Reference

/api/events for event details /api/scoreboard for score details