/node-gavel

A project submission and judging platform inspired by Gavel: https://github.com/anishathalye/gavel

Primary LanguageJavaScript

An expo judging system based on the original Gavel: https://github.com/anishathalye/gavel. This project is in development and not ready for use. Junction is currently developing this platform for use in various Junction events, and the project will be properly documented after it has been successfully tested there (beginning of 2019 most likely).

Prerequisites

Clone the repo

git clone git@github.com:hackjunction/node-gavel.git
 cd node-gavel

Install dependencies

Run npm run setup at the root of the project. Only needs to be run again whenever dependencies change.

Add ENV files

First, for the app to run at all, you need to add an .env file with the following contents at the root of /client:

PORT=5000

Then, check out the configuration options in /api/settings.js

If you want to override some of the default configuration options, place an .env file at the root of the project with your overrides (same level as server.js).

Starting the development server

Run yarn dev, this will start the development server at localhost:3000, and the admin panel frontend at localhost:5000. Both the API and the frontend will automatically reload whenever code changes are saved.

Others

VSCode Settings Sync Gist ID: 5afa14f85102f6000f96ba682cfda51d (if you wish to use my VSCode theme and settings)