Contributing Guide

This is a static snapshot of a university project.

Prerequisites

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

Setup

Clone the repository
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,)
- If you are using autosave: Settings → Autosave → On Focus Change ("files.autoSave": "onFocusChange",)
Vue Language Features (Volar) Extension for Vue.js
TypeScript Vue Plugin (Volar) Extension for Vue.js
Eslint Extension to automatically show lots of little warnings
Tailwind CSS to get nice Tailwind support
(optional)Auto Import Extension to easily import files
(optional)Error Lens to see all the errors inline with the code
(optional)TODO Highlight Extension

I also totally recommend using a decent browser such as Firefox or a Chromium browser with

Vue Devtools to get top-notch debugging support

Used Libraries

The most important ones are

Typescript - Typesafe Javascript
Vue 3 - Vue 3 with the composition API
Tailwind CSS - tons of CSS utility classes

We are also using

Vite - a speedy Vue.js framework
vue-toastification
vue-router - see router/index.ts for the defined URL routes
ky - for making REST requests
pinia - our central store
jspdf-invoice-template - to quickly create invoices from JSON
date-fns - utility functions for working with dates until the Temporal API finally gets released
vuelidate - for validating forms
heroicons - for pretty icons

For more, check out the package.json