Update Readme

This commit is contained in:
Paul 2024-02-18 12:33:57 +01:00
parent 32f8cfaf25
commit 6e08dfa3ad
6 changed files with 96 additions and 43 deletions

View File

@ -1,52 +1,53 @@
# kinderbuch
# DigS-Gov Babybuch
Was bei der Geburt eines Kindes in den Ämtern abläuft, ist nicht leicht zu durchschauen. Bei dem Spiel handelt es sich um ein interaktives Lernspiel für zukünftige Verwaltungsleistungen. Dieses Spiel ermöglicht es, auf spielerische Weise zu erfahren, welche Daten und Informationen bei einer Geburt zu den Ämtern fließen. Dabei gibt es die Wahl zwischen einem einfachen Bilderbuch für Kinder und einem Buch mit tiefergreifenden Informationen.
## Oberfläche
| ![Start](readme_res/Startseite.PNG) | ![Quiz](readme_res/Buchstart.PNG) |
|---|---|
| *Startseite mit beiden Buchvarianten* | *Erste Seite der beiden Bücher* |
| ![Auswahl](readme_res/Buch1.PNG) | ![Legende](readme_res/Buch2.PNG) |
| *Buch mit weiteren Informationen* | *Bilderbuch für Kinder* |
This template should help get you started developing with Vue 3 in Vite.
## Recommended IDE Setup
## Technik
- **Lizenz:** [OpenSource](https://creativecommons.org/licenses/by/4.0/)
- **Projektbeteiligte**
- DigS-Gov: Universität zu Lübeck: Institut für Multimediale und Interaktive Systeme, Ethical Innovation Hub
- Mach AG
- Hansestadt Lübeck
- Gefördert durch das Bundesministerium für Bildung und Forschung
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
## Type Support for `.vue` Imports in TS
- **Software (Versionsnummer)**
- Node.js (v16.14.0.)
- npm (8.3.1)
- Vite (v4.5.2)
- Vue.js (3.4.15)
- VSCode + Volar (ohne Vetur)
- TypeScript
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
- **Befehle**
- Projekt Setup
- npm install
- Kompilieren
- npm run dev
- Projekt bauen
- npm run build
- Testen
- npm run test:unit
- ESLint
- npm run lint
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
## Vite Konfiguration
[Vite Configuration Reference](https://vitejs.dev/config/).
## Wissenschaftliche Erkenntnisse [JIL](https://jil.sh/portfolio/projekte/digs-gov/)
Das Joint Innovation Lab forscht, entwickelt und berät zur Digitalen Transformation im öffentlichen Sektor. Die wissenschaftlichen Erkenntnisse finden Sie auf der [DigS-Gov Projektwebsite](https://jil.sh/portfolio/projekte/digs-gov/)
1. Disable the built-in TypeScript Extension
1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
## Kontakt
- Universität zu Lübeck, Institut für Multimediale und Interaktive Systeme (IMIS),Ratzeburger Allee 160, 23562 Lübeck, Deutschland,
- Tel.: +49 451 3101 5101
## Customize configuration
### Ansprechpartner
- Karlson Hanke, karlson.hanke@uni-luebeck.de
See [Vite Configuration Reference](https://vitejs.dev/config/).
## Project Setup
```sh
npm install
```
### Compile and Hot-Reload for Development
```sh
npm run dev
```
### Type-Check, Compile and Minify for Production
```sh
npm run build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
npm run test:unit
```
### Lint with [ESLint](https://eslint.org/)
```sh
npm run lint
```
#### Letzte Änderung
- 18.02.2024

52
README_old.md Normal file
View File

@ -0,0 +1,52 @@
# kinderbuch
This template should help get you started developing with Vue 3 in Vite.
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
## Type Support for `.vue` Imports in TS
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
1. Disable the built-in TypeScript Extension
1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
## Customize configuration
See [Vite Configuration Reference](https://vitejs.dev/config/).
## Project Setup
```sh
npm install
```
### Compile and Hot-Reload for Development
```sh
npm run dev
```
### Type-Check, Compile and Minify for Production
```sh
npm run build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
npm run test:unit
```
### Lint with [ESLint](https://eslint.org/)
```sh
npm run lint
```

BIN
readme_res/Buch1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.0 MiB

BIN
readme_res/Buch2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 MiB

BIN
readme_res/Buchstart.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

BIN
readme_res/Startseite.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 MiB