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 297741d9fc
continuous-integration/drone/push Build is passing Details
Added LfK imprint
2022-10-10 17:27:07 +02:00
.argo Removed secret 2022-10-10 17:25:05 +02:00
src Added LfK imprint 2022-10-10 17:27:07 +02:00
.dockerignore Added dockerignore 2022-10-10 17:02:41 +02:00
.drone.yml Removed ci license export 2022-10-10 17:06:07 +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 Docker bump 2022-10-10 17:02:34 +02: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 Dependency bump 2022-10-10 17:00:32 +02: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