The documentation for the "Läufersystem". Powered by Vuepress. Automatically deployed to docs.lauf-fuer-kaya.de https://docs.lauf-fuer-kaya.de
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Nicolai Ort 6fed301721 removed pdf from gitignore 5 months ago
src removed pdf from gitignore 5 months ago
.drone.yml Applied Docker MTU fix 🛠 6 months ago
.gitignore removed pdf from gitignore 5 months ago
.npmignore initial vuepress 7 months ago
Dockerfile Changed pnpm->yarn b/c of sporadic build issues 5 months ago
README.md Added translations 7 months ago
docker-compose.yml Implemented basics for deployment via docker 7 months ago
licenses.md new license file version [CI SKIP] 5 months ago
nginx.conf Implemented basics for deployment via docker 7 months ago
package.json Pinned/bumped dependencies 5 months ago

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