Installation

caution

This is a work in progress. This document will be replaced later on.

Installation guide

To get started, clone the following branch from skeleton. This branch is configured to work with a local qore directory for the time being.

git clone -b feature/frontend-v2 git@gitlab.qlic.nl:qore/skeleton-v2.git

Go into the new directory, and install back-end dependencies (similar to normal skeleton installation).

info

You can potentially also use another skeleton back-end for testing purposes, however you may run into problems.

Then, cd into frontend and clone the front-end v2 repository with a certain branch. At this time of writing, the current_phase_number is: 2.

git clone -b feature/phase-{current_phase_number} git@gitlab.qlic.nl:qore/frontend-v2.git qore

Copy the .env.example file to .env:

cp .env.example .env

Make sure you are on a Node version >= 16:

node -v

Then stay in the frontend directory and install the dependencies:

yarn

After that, you can start the development server (Vite):

yarn dev

The yarn dev command should be fast, and you should be greeted by the login screen.

It is very important that you disable the Vetur extension, because it is not compatible with Vue3.

Instead, use the extensions that are recommended in the extensions.json file:

"vue.volar",
"vue.vscode-typescript-vue-plugin",
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode",
"bradlc.vscode-tailwindcss"

In this pre-configured skeleton branch, there are 3 files changed in order to make the local development (with a local qore directory) work:

Read the comments inside each file in order to see what is added and can be removed later on when qore is installed via NPM.