Added readme for the repo

This commit is contained in:
Nicolai Ort 2021-02-13 21:58:39 +01:00
parent 6b5ba5d9f9
commit 03b91b18cf
1 changed files with 32 additions and 0 deletions

32
README.md Normal file
View File

@ -0,0 +1,32 @@
# @lfk/documentation
The documentation for the LfK! 'Läufersystem'.
Powered by Vuepress.
## 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
2. Run docker-compose: `docker-compose up -d`
3. 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
```bash
yarn
```
2. Start the server
```bash
yarn dev
```
## Recommended Editor
[Visual Studio Code](https://code.visualstudio.com/)
### Recommended Extensions
* will be automatically recommended via ./vscode/extensions.json