lfk
/
docs
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
The documentation for the "Läufersystem". Powered by Vuepress. Automatically deployed to docs.lauf-fuer-kaya.de https://docs.lauf-fuer-kaya.de
27 Commits 2 Branches 0 Tags 1.1 MiB
JavaScript 78.3%
Dockerfile 8.1%
Vue 7.9%
Stylus 5.7%
Go to file
Nicolai Ort 769251c062 Added translations 2021-02-15 18:00:35 +01:00
src Added translations 2021-02-15 18:00:35 +01:00
.drone.yml Added ci basics 2021-02-13 22:11:49 +01:00
.gitignore Added gitingore 2021-02-13 20:13:28 +01:00
.npmignore initial vuepress 2021-02-13 20:12:43 +01:00
Dockerfile Implemented basics for deployment via docker 2021-02-13 22:09:00 +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
nginx.conf Implemented basics for deployment via docker 2021-02-13 22:09:00 +01:00
package.json Added license export basics 2021-02-13 22:11:38 +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

Recommended Editor

Visual Studio Code

Recommended Extensions

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