Added readme

README.md

@@ -1,38 +1,27 @@
-# create-svelte
+# @lfk/kiosk
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
+## Overview 👀
+This is a simple kiosk style register form for the LfK runnersystem.
+The basic idea is:
+1. Create a runnersystem user with only `RUNNER:CREATE` permissions.
+2. Login with this user under `/login`
+3. Runners can register via their firstnam and lastname
+4. The kiosk creates the runner via the backend and shows their id, firstname, lastname and a barcode containing their id
 
-## Creating a project
+## Development 🛠️
-
+```
-If you're seeing this, you've probably already done this step. Congrats!
+pnpm i
-
+pnpm dev --open
-```bash
-# create a new project in the current directory
-npm create svelte@latest
-
-# create a new project in my-app
-npm create svelte@latest my-app
 ```
 
-## Developing
+## Build 🚀
-
+```
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+pnpm i
-
+pnpm build
-```bash
-npm run dev
-
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
 ```
 
-## Building
+## Docker 🐳
-
-To create a production version of your app:
-
-```bash
-npm run build
 ```
-
+docker build .
-You can preview the production build with `npm run preview`.
+docker-compose up
-
+```
-> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.

package.json

@@ -2,6 +2,25 @@
 	"name": "@lfk/kiosk",
 	"version": "0.0.1",
 	"private": false,
+	"license": "MIT",
+	"repository": "https://git.odit.services/lfk/kiosk",
+	"author": {
+		"name": "ODIT.Services",
+		"email": "info@odit.services",
+		"url": "https://odit.services"
+	},
+	"contributors": [
+		{
+			"name": "Philipp Dormann",
+			"email": "philipp@philippdormann.de",
+			"url": "https://philippdormann.de"
+		},
+		{
+			"name": "Nicolai Ort",
+			"email": "info@nicolai-ort.com",
+			"url": "https://nicolai-ort.com"
+		}
+	],
 	"scripts": {
 		"dev": "vite dev",
 		"build": "vite build",
@@ -39,7 +58,7 @@
 	},
 	"type": "module",
 	"dependencies": {
-		"@odit/lfk-client-js": "^1.0.1",
+		"@odit/lfk-client-js": "1.0.1",
 		"bwip-js": "3.4.0"
 	},
 	"release-it": {