Contributing Guide

Welcome, interested person! Contributions are welcome. If you're ever unsure, feel free to open an issue.

Preferably, features are developed in another branch or fork. After the feature is ready, a pull request to the master branch should be opened.

Prerequisites

Node 15 or greater. Don't install Chocolatey.
A code editor (see below)

Setup

Fork the repository
Clone your fork
npm install
npm run dev

Recommended Tooling

I recommend using Visual Studio Code with

Prettier Extension to format your files
Settings → Format On Save → Enable ("editor.formatOnSave": true,)
Volar Extension for Vue.js
(optional)npm Extension
(optional)TODO Highlight Extension

Used Libraries

The most important ones are

Typescript - Typesafe Javascript
Vue 3 - Vue 3 with the composition API

We are also using

Vite - a speedy Vue.js framework

Code Structure