Girder + Vite Proof of Concept

This is a proof of concept of a Vite SPA build for Girder.

How to use it:

• Get girder server running on localhost:8080 (i.e. clone this repo, pip install -e ., girder serve)
• You need to enable a CORS allowed origin in Girder settings for the experimental SPA. This is somewhat a chicken-and-egg scenario since it's easiest to change this setting from the Girder web admin UI itself. This could be accomplished by having a separate checkout of girder on the master branch where you do girder build (girder build is broken on this branch).
• cd girder/web_client
• npm i
• npm run dev
• Unit test: npm run test:unit
• End-to-end test: npm run test:e2e

What works

• Girder core interface
• Some really basic JS unit testing with vitest and JS end-to-end testing with playwright

What doesn't work

• The Girder logo does not work due to Pug require() being broken
• Any of the large volume of existing end-to-end tests
• Any plugin client code

girder-web-client

This template should help get you started developing with Vue 3 in Vite.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

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 TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run Extensions: Show Built-in Extensions from VSCode's command palette
   2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Run End-to-End Tests with Playwright

# Install browsers for the first run
npx playwright install

# When testing on CI, must build the project first
npm run build

# Runs the end-to-end tests
npm run test:e2e
# Runs the tests only on Chromium
npm run test:e2e -- --project=chromium
# Runs the tests of a specific file
npm run test:e2e -- tests/example.spec.ts
# Runs the tests in debug mode
npm run test:e2e -- --debug

Lint with ESLint

npm run lint