korp-vue

A Vue 3 rewrite of korp-frontend.

Status: experimental

Quick setup

git clone [email protected]:spraakbanken/korp-vue
git clone [email protected]:spraakbanken/korp-vue-sb
cd korp-vue
ln -s ../korp-vue-sb instance
yarn install
yarn dev

Setup details

The code requires an instance plugin with site-specific config and extensions to be placed in instance/.

src/                  # Main app code, alias: "@/"
instance/             # This folder is in .gitignore, add it yourself, alias: "@instance/"
instance/plugin.ts    # Instance plugin
instance/settings.ts  # Instance settings

• Instance plugin – must export an function that returns Promise<Plugin>, used by src/main.ts, see Vue Plugin docs
• Instance settings - must export an object with frontend settings

SSL in development

To activate SSL (e.g. for ?mode=mink which uses SB-Auth):

1. Point the hostname korpdev.spraakbanken.gu.se to localhost. On a UNIX system, you can do this by editing /etc/hosts.
2. Create certificate files with mkcert:

   mkcert "*.spraakbanken.gu.se"

3. Set these environment variables in .env or otherwise:

   KORP_HOST=korpdev.spraakbanken.gu.se
   DEV_HTTPS_KEY=_wildcard.spraakbanken.gu.se-key.pem
   DEV_HTTPS_CERT=_wildcard.spraakbanken.gu.se.pem

Development

• Install deps by running yarn (v1)
• Run with yarn dev