HITCON Dashboard

The HITCON dashboard serves as a scorekeeping tool designed to aggregate data from each event within HITCON CMT 2023. This data is then organized into a table format for display on a website.

Quick Start

# build frontend
cd ../dashboard-frontend
yarn
yarn build
cd ../dashboard-backend

# install backend dependency
npm install

# remove existing database
rm prisma/dev.db

# set db path environment variable
# windows
# set DATABASE_URL="file:./dev.db"
# linux
export DATABASE_URL="file:./dev.db"

# create db
npm run db:init

# start dev server
# windodws
# npm run dev:win
# linux
npm run dev
# or with production environment
# npm run start

Environment

Make sure the environment variables are set, or create .env file in the this directory, which will be loaded automatically.

# required
DATABASE_URL="file:./dev.db"
BADGE_DATABASE_URL="mongodb://{user}:{password}@{host}:{port}/badge?authSource=admin"

# optional
PORT="5002"
NODE_ENV="production"
API_KEY="xxx"

Database

Model schema is defined in prisma/schema.prisma.

To update database after modifing the schema file:

Remove old prisma/dev.db
Run npx prisma db push to create database file

Deploy Dashboard

Remember to set API_KEY with docker run, or it will be random

docker build -t dashboard -f Dockerfile.dashboard .
docker run -p 127.0.0.1:5000:5000 -e API_KEY="<API_KEY>" -e BADGE_DATABASE_URL="<BADGE_DATABASE_URL>" dashboard

You can mount /db in container to store database in host

Docs

docs/swagger.json is updated automatically when dev server is running.

Run npm run build:docs to update docs/swagger.json manually.

zeze-zeze / hitcon-dashboard