Task Tracker Framework

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

use npm run serve -- --mode [mode] to run with alternative .env.[mode] or .env.[mode].local files. the additional -- is nessesary to ensure the --mode flag gets passed to the vue-cli-service

Builds and deploys to Github Pages

(builds to the gh-pages branch with the options in .env.local or .env)

nvm use 18 && npm run deploy

Production Brief discovery (/.well-known/brief.json on cmutt.app) is generated at deploy time — never a committed production JSON file. deploy.js runs scripts/generate-brief-config.js before vue-cli-service build, then publishes dist/ to gh-pages. CI npm run build also regenerates via prebuild, but live Pages only updates when you run npm run deploy.

Publish uses gh-pages -d dist --dotfiles so .well-known is not skipped, and public/.nojekyll lands in dist/ so GitHub Pages/Jekyll does not strip dot-directories.

Production cmutt (preferred SSOT): copy brochure config from the live API so humans only edit server env (e.g. mvtt-server .env.cmu-tt). In the deploy .env / .env.local:

BRIEF_FETCH_CONFIG=1
BRIEF_CONFIG_URL=https://api.cmutt.app/api/v1/client-config

Discrete BRIEF_* (and .env.test) remain for offline CI and forks — see example.env. Never commit service accounts; Firebase client fields are OK.

or optionally when cmu-tt is side-by-side (requires all changes to be pushed to remote for full parity):

nvm use 18 && npm run deploy & (cd ../cmu-tt.github.io && nvm use 18 && npm run deploy) & (cd ../villanova-tt.github.io && nvm use 18 && npm run deploy)

Builds the documentation

rm -r -f public/docs && tsc --outDir tmp --rootDir src && jsdoc -c jsdoc.config && rm -r -f tmp

To-dos and Feature roadmap

Useful links

Home · About · Contact · Documentation