diff --git a/README.md b/README.md index 5c91169..7e85e3f 100644 --- a/README.md +++ b/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 - -If you're seeing this, you've probably already done this step. Congrats! - -```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 +## Development 🛠️ +``` +pnpm i +pnpm dev --open ``` -## Developing - -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: - -```bash -npm run dev - -# or start the server and open the app in a new browser tab -npm run dev -- --open +## Build 🚀 +``` +pnpm i +pnpm build ``` -## Building - -To create a production version of your app: - -```bash -npm run build +## Docker 🐳 ``` - -You can preview the production build with `npm run preview`. - -> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. +docker build . +docker-compose up +``` \ No newline at end of file