girder / vue-project-template

Project template for Girder 4 SPA front-end applications

Vue Project Template

This is a project boilerplate template designed for building SPAs that will serve as front-ends to Girder 4-based servers. The following features are included:

• vuetify installation and configuration
• axios installation and configuration
• vue-router installation and skeleton boilerplate
• Girder 4 OAuth client library installation and configuration
• A home page containing a working OAuth login / logout button
• Sentry integration (if no DSN is provided, this will be inactive)
• TypeScript
• Best-practice eslint configuration
• GitHub Actions CI that runs tests, lint, and build

How to use this template

1. Click the button in GitHub that says Use this template.

If you don't want to use GitHub, you can instead clone the repository, rm -rf .git/ in it, and git init the copy.

2. After you have your copy, replace occurrences of CHANGEME in the codebase.

git grep CHANGEME

Recommended IDE Setup

• VSCode + Volar

Type Support For .vue Imports in TS

Since TypeScript cannot handle type information for .vue imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in .vue imports (for example to get props validation when using manual h(...) calls), you can enable Volar's .vue type support plugin by running Volar: Switch TS Plugin on/off from VSCode command palette.

vue-project-template's Issues

Upgrade to latest vuetify

Vuetify 3 is now out of beta, so we should update the version in package.json / yarn.lock.

Prepare a Vue 3 fork

Work is ongoing to prepare a Vue 3 version of this template:

https://github.com/girder/vue-project-template/tree/vue-3

Upgrade to composition API

change all code to be composition api according to norms.

Correctly configure sentry

The current sentry configuration is missing some necessary details and some recommended fields.

Needs the Vue integration, a reasonable release identifier, and an environment identifier.

Might also be nice to add VueGtag google analytics.

Housekeeping dump

@subdavis feel free to break this up into separate issues. Just dumping for now.

• Opportunities to add stuff:

  • Pre-configured vuetify theme customization (colors, fonts)
  • Pre-configured vuetify SASS variable customization (It’s easy, but you have to read the docs and I hate reading)

• Instructions for upgrading deps on ejection.

• Maybe some info on hash vs history routing, and some vue.config.js proxy setup.

• Just mention netify, django, nginx docs?

• Mention in the readme that this can be used with any old backend and just remove a couple small bits.

• (Brandon): I’m going to check in a “next” branch with my attempt at a Vue 3 Vite project. Once Vuetify 3 is ready, we can talk about switching it, but meanwhile, it will be a place to iterate on our “best practices for Vue3”.