lfk/docs

Fork 0

Go to file

Nicolai Ort e5be5ae4d5

continuous-integration/drone/push Build is passing

Details

Switched to npm cache for build

2023-03-17 15:38:46 +01:00

.argo

Fresh argo move to new h2 cluster

2023-01-10 18:34:54 +01:00

src

Added Citizen Group warning to selfservice

2023-02-15 14:39:10 +01:00

.dockerignore

Added dockerignore

2022-10-10 17:02:41 +02:00

.drone.yml

Switched to npm cache for build

2023-03-17 15:38:46 +01:00

.gitignore

Ignore secret

2022-10-10 17:25:19 +02:00

.npmignore

initial vuepress

2021-02-13 20:12:43 +01:00

docker-compose.yml

Implemented basics for deployment via docker

2021-02-13 22:09:00 +01:00

Dockerfile

Switched to npm cache for build

2023-03-17 15:38:46 +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

Added translations

2021-02-15 18:00:35 +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.

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

Dev Setup 🛠

Local dev setup for previewing changes.

Install Dependencies
```
yarn
```
Start the server
```
yarn dev
```

Recommended Editor

Visual Studio Code

Recommended Extensions

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