Home | Emulators | Seeds & Migrations | Deployment | Test Runners | Known Issues

Codee-Club Developer Guide

Welcome new developer! Please read below to get started :)

Shell commands should be run in VSCode terminal, from the project-root directory (unless stated otherwise).

Developer Tools

Install programs & extensions:

• Google Cloud SDK
• Vue Devtools
• VSCode + extensions:
  • ESLint for ts/js
  • Prettier for html/scss/js/json
  • stylelint for scss
  • Vetur for vue
  • Format Code Action
  • TabNine for AI suggestions (optional)
  • Folder Templates (optional)

Install CLI tools (paste & run in VSCode terminal):

npm i -g firebase-tools lerna serve typescript yarn

Login to Firebase

firebase login
firebase use default

Dependencies & Build

Install deps, build project, and setup configuration:

yarn && yarn build && yarn bootstrap

If you get the error: The engine "node" is incompatible with this module, then tell yarn to ignore the node version:

yarn config set ignore-engines true

Quick Start

Start the emulator:

yarn emu

Seed example data (also runs migrations):

yarn seed

Watch & compile modules (if editing common or functions):

yarn watch

Run the web app (if editing hosting):

yarn serve