Recommended IDE Setup

VSCode + Volar (and disable Vetur).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need Volar to make the TypeScript language service aware of .vue types.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Use Production Assets in Dev Testing (workgroup:mozilla-confidential metadata)

Warning

Do not commit these files

gsutil cp gs://protosaur-stage-iap-static-website/dawg/static/gcpv2_merged.json public/
VITE_USE_PROD_DATA=true npm run dev

Lint with ESLint

npm run lint

Testing

Run all test concurrently

npm run test

Run Type Tests/Checking

npm run test:types

Run Unit Tests with Vitetest

npm run test:unit

Run End-to-End Tests with Playwright

# Install browsers for the first run
npx playwright install

# Runs the end-to-end tests
npm run test:e2e

# Runs the tests in debug mode
npm run test:e2e -- --debug

# Runs the e2e tests w/ CI configuration
CI=true npm run test:e2e

Compile and Minify for Production

npm run build