Compare commits

...

3 Commits

Author SHA1 Message Date
96ec5fd666
feat(container): Docker-Compose 2025-01-16 22:12:03 +01:00
e24fbab7e9
docs: Re-Added Readme 2025-01-16 22:11:25 +01:00
74b4139b8d
feat(container): Dockerfile 2025-01-16 22:08:31 +01:00
3 changed files with 41 additions and 0 deletions

8
Dockerfile Normal file
View File

@ -0,0 +1,8 @@
FROM registry.odit.services/hub/hugomods/hugo:exts as build
WORKDIR /app
COPY . /app/
RUN hugo
FROM registry.odit.services/hub/hugomods/hugo:nginx
COPY --from=build /app/public /site

27
README.md Normal file
View File

@ -0,0 +1,27 @@
# @lfk/documentation
The documentation for the LfK! 'Läufersystem'.
Powered by Hugo.
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) but every page has an English translation.
## 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. Clone the repo
2. Install Hugo: `brew install hugo` or `winget install hugo.hugo.extended`
3. Start the dev server: `hugo server --buildDrafts --disableFastRender`
### Recommended Editor
[Visual Studio Code](https://code.visualstudio.com/)

6
docker-compose.yml Normal file
View File

@ -0,0 +1,6 @@
version: "3.3"
services:
httpd:
build: .
ports:
- 8080:80