Skip to content

Latest commit

 

History

History
63 lines (52 loc) · 2.84 KB

README.md

File metadata and controls

63 lines (52 loc) · 2.84 KB
Raw

Stories in Ready Code Climate Test Coverage Issue Count Dependency Status devDependency Status Circle CI Join the chat at https://gitter.im/IEEECS-VIT/GPL

graVITas Premier League

The graVITas Premier League code repository

This website is hosted here

For exhaustive documentation, check out the project wiki

Please report any bugs or issues here
Instructions for Installation
  • Install the latest edition of Node.js from here
  • Install the latest version of MongoDB from here
  • Install all dependencies with npm i --silent
  • Create a file .env in the root directory with the following contents:
KEY=value
DAY=value
OUT=value
LIVE=value
MATCH=value
BAT_AVG=value
BAT_STR=value
BOWL_AVG=value
BOWL_STR=value
BOWL_ECO=value
GOOGLE_ID=value
GOOGLE_KEY=value
TWITTER_ID=value
TWITTER_KEY=value
FACEBOOK_ID=value
FACEBOOK_KEY=value
COOKIE_SECRET=randomsecretstring
SESSION_SECRET=randomsecretstring
MONGO=mongodb://127.0.0.1:27017/GPL
  • Start the localhost mongod server via mongod
  • Seed the local database with npm run seed
  • Generate match schedules with npm run schedule
  • Run the server locally at port 3000 or "PORT" in process.env with npm start
  • View the website at localhost:3000 within your browser
  • Generate project documentation with npm run docs

External Requirements:

  • A MongoDB instance running locally or valid MONGO string in process.env
  • Valid social authentication tokens in process.env
  • A valid COOKIE_SECRET string in process.env for better security (Optional)
  • A valid LOGENTRIES_TOKEN in process.env for Logentries support (Optional)
  • Valid NEWRELIC_APP_NAME, NEWRELIC_LICENSE in process.env (Optional)
  • A valid SENTRY_DSN token in process.env for Sentry error alerts (optional)