Skip to content

phits-tech/website

Repository files navigation

Home | CLI | Emulators | Deployment

Phits-Tech Developer Guide

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

Run shell commands in VSCode terminal (from the root directory unless stated otherwise).

Developer Tools

Install programs & extensions:

  1. VSCode
  2. Vue Devtools (beta)
  3. Google Cloud SDK

Install CLI tools & VSCode extensions:

npm run install-tools

First-time Setup

Login to Firebase

firebase login
firebase use default

Install deps, build project, and setup configuration:

yarn config set ignore-engines true
yarn && yarn build && yarn config-sync

Dev Quick Start

Open 3 terminals & execute these commands (in order):

  1. Watch common & functions (build when the source changes)
  2. Start cloud services emulator (fake db, auth, cloud functions)
  3. Load example data & start hosting webserver (w/ auto-update)
Terminal 1 Terminal 2 Terminal 3
yarn watch yarn emu yarn seed && yarn dev

Debugging

Ask for help on Phits.Tech Discord :)