style(docs): Linting
	
		
			
	
		
	
	
		
	
		
			All checks were successful
		
		
	
	
		
			
				
	
				Build latest image / build-container (push) Successful in 44s
				
			
		
		
	
	
				
					
				
			
		
			All checks were successful
		
		
	
	Build latest image / build-container (push) Successful in 44s
				
			This commit is contained in:
		
							
								
								
									
										20
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										20
									
								
								README.md
									
									
									
									
									
								
							@@ -1,32 +1,38 @@
 | 
				
			|||||||
# @lfk/kiosk
 | 
					# @lfk/kiosk
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Overview 👀
 | 
					## Overview 👀
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This is a simple kiosk style register form for the LfK runnersystem.
 | 
					This is a simple kiosk style register form for the LfK runnersystem.
 | 
				
			||||||
The basic idea is:
 | 
					The basic idea is:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
1. Create a runnersystem user with only `RUNNER:CREATE` permissions.
 | 
					1. Create a runnersystem user with only `RUNNER:CREATE` permissions.
 | 
				
			||||||
2. Login with this user under `/login`
 | 
					2. Login with this user under `/login`
 | 
				
			||||||
3. Runners can register via their firstnam and lastname
 | 
					3. Runners can register via their firstname and lastname
 | 
				
			||||||
4. The kiosk creates the runner via the backend and shows their id, firstname, lastname and a barcode containing their id
 | 
					4. The kiosk creates the runner via the backend and shows their id, firstname, lastname and a barcode containing their id along
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Development 🛠️
 | 
					## Development 🛠️
 | 
				
			||||||
```
 | 
					
 | 
				
			||||||
 | 
					```shell
 | 
				
			||||||
pnpm i
 | 
					pnpm i
 | 
				
			||||||
pnpm dev --open
 | 
					pnpm dev --open
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Build 🚀
 | 
					## Build 🚀
 | 
				
			||||||
```
 | 
					
 | 
				
			||||||
 | 
					```shell
 | 
				
			||||||
pnpm i
 | 
					pnpm i
 | 
				
			||||||
pnpm build
 | 
					pnpm build
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Docker 🐳
 | 
					## Docker 🐳
 | 
				
			||||||
```
 | 
					
 | 
				
			||||||
 | 
					```shell
 | 
				
			||||||
docker build .
 | 
					docker build .
 | 
				
			||||||
docker-compose up
 | 
					docker-compose up
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Kiosk Google Chrome
 | 
					## Kiosk Google Chrome
 | 
				
			||||||
```
 | 
					
 | 
				
			||||||
 | 
					``` shell
 | 
				
			||||||
chrome https://run.lauf-fuer-kaya.de/kiosk/ -kiosk
 | 
					chrome https://run.lauf-fuer-kaya.de/kiosk/ -kiosk
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user