Skip to content

✒️ Scoresheets: scorekeeping and judging for Science Olympiad tournaments

Notifications You must be signed in to change notification settings

mi-yu/scoresheets-server

Repository files navigation

✒️ scoresheets.io (server)

A scorekeeping and judging system for Science Olympiad tournaments.

CircleCI

Features:

  • Allows event supervisors to submit scores
  • Automatic generation of scoresheets and awards presentation
  • ESUS-like time slot registration
  • Team, schedule, and room management system

Run Locally:

  1. Install MongoDB
  2. Install Node (comes with npm)
  3. Install Yarn (our package manager) with npm i -g yarn
  4. Clone repo

Then in project root:

  1. Create .env file with the following contents:

    DB_LOCAL_URL=mongodb://localhost/scoresheets-dev
    NODE_ENV=development
    JWT_SECRET=whatever-string-you-want
    
  2. Run yarn install to install dependencies

  3. In separate console, run mongod (local development database)

  4. Run yarn start:dev, API server should start up at localhost:5000

Interacting with the API

  1. Install Postman
  2. yarn start:dev
  3. Hit endpoints with Postman, something like localhost:5000/status

Automated Tests:

  1. Install Jest (testing framework) with yarn global add jest
  2. Run yarn test

About

✒️ Scoresheets: scorekeeping and judging for Science Olympiad tournaments

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published