The documentation for the "Läufersystem". Powered by Vuepress. Automatically deployed to docs.lauf-fuer-kaya.de https://docs.lauf-fuer-kaya.de
Go to file
Nicolai Ort 37c89bedae
ci/woodpecker/push/build Pipeline was successful Details
chore(deps): Bump to latest vuepress maintainance release
2024-02-25 17:19:08 +01:00
.argo traefik.io/v1alpha1 crds 2023-05-31 15:05:52 +02:00
.woodpecker ci: migrate to woodpecker 2023-11-06 19:27:51 +01:00
src Updated scanner recommendations 2023-04-15 23:13:57 +02:00
.dockerignore Added dockerignore 2022-10-10 17:02:41 +02:00
.gitignore Ignore secret 2022-10-10 17:25:19 +02:00
.npmignore initial vuepress 2021-02-13 20:12:43 +01:00
Dockerfile fix(deps): Back to old node for max compatavility 2024-02-25 17:12:20 +01:00
README.md Added translations 2021-02-15 18:00:35 +01:00
docker-compose.yml Implemented basics for deployment via docker 2021-02-13 22:09:00 +01:00
licenses.md new license file version [CI SKIP] 2021-04-06 16:58:10 +00:00
nginx.conf Implemented basics for deployment via docker 2021-02-13 22:09:00 +01:00
package.json chore(deps): Bump to latest vuepress maintainance release 2024-02-25 17:19:08 +01:00

README.md

@lfk/documentation

The documentation for the LfK! 'Läufersystem'. Powered by Vuepress.

The main language for the content is German (since our primary target audience is the Lauf für Kaya! Team at a local German school).

Quickstart 🐳

Use this to run the documentation server via docker.

  1. Clone the repo or copy the docker-compose.yml
  2. Cd into the folder containing the docker-compose.yml
  3. Run docker-compose: docker-compose up -d
  4. Visit http://127.0.0.1:8080/ to check if the server is running

Dev Setup 🛠

Local dev setup for previewing changes.

  1. Install Dependencies
    yarn
    
  2. Start the server
    yarn dev
    

Visual Studio Code

  • will be automatically recommended via ./vscode/extensions.json