WME Structured Contents Endpoint Demo

This is an example on how you would fill in the "knowledge panel" using Wikimedia Enterprise APIs.

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

Lint with ESLint

npm run lint

Deploying the app

1. Checkout github pages branch:

git checkout --orphan gh-pages

2. Build the application:

npm run build

3. Add result of the build to the work tree:

git --work-tree dist add --all

4. Create a deployment commit:

git --work-tree dist commit -m 'Deploy'

5. Push the changes to remote branch gh-pages:

git push origin HEAD:gh-pages --force

6. Clean up the dist folder:

rm -r dist

7. Return to the main branch:

git checkout -f main

8. Remove local version of gh-pages brach:

git branch -D gh-pages