Development Guide v0.0.0

For easy installation, please follow the instructions under Getting Started.

On this page, we describe the full installation process needed for developers. The PanVA source repository is available on GitHub. After you cloned or forked the repo, please follow our recommendations below.

Recommended IDE Setup

VSCode + Vue - Official extension for language support.

Type Support for .vue Imports in TS

For Typescript support, please make sure the built-in Typescript extension is enabled (default enabled). To check this, go to the Extensions tab and type @builtin typescript and javascript.

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 to enable Vue - Official extension for language support to make the TypeScript language service aware of .vue types.

WARNING

Previously, we used TypeScript Vue Plugin (Volar). This extension is deprecated. Use the Vue - Official extension instead.

Frontend

We use nvm to use a specific node version when developing.

nvm install
nvm use
npm ci

When nvm is installed correctly, the version defined in .nvmrc should be automatically loaded when a terminal is opened in the frontend directory. If not, you need to run nvm use before running npm commands.

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Lint with ESLint

npm run lint

API code

Install Poetry

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
poetry config virtualenvs.in-project true # For linters to work with VSCode

Install project dependencies

poetry install

Run the application

poetry run python app.py

The application will then be available on http://localhost:5001/.