Contributing

The stack is that of MinOS and Kolekti: Vue 3, Vite, TypeScript, Vuetify, Vitest, Hono, VitePress, yarn 4, ESLint, Prettier.

Run the project

yarn install

In three terminals:

yarn dev:server

yarn dev

yarn docs:dev

The page is at http://localhost:5173, and the documentation at http://localhost:5174. The relay talks to the real Nextcloud by default: to run tests, point it elsewhere with CORICO_NEXTCLOUD.

The demonstration video

yarn video films it again, on a virtual screen, with a fake Nextcloud and a fake microphone (demos/video/README.md); yarn video:publish sends it to the documentation's site.

Check before proposing

yarn lint

yarn typecheck

yarn test

yarn docs:build

The project's rules

• The relay keeps nothing. No storage, no request log, no third-party service. Any change to what is seen, kept or sent updates the privacy page in the same commit.
• Two languages. The interface and the documentation exist in English and in French, and every change touches both.
• Documentation for everyone. The guide is for teachers: no technical word without an explanation, and every new word joins the glossary.
• Interface first. Read the interface choices before touching it.
• Atomic commits, one subject per commit.