diff --git a/README.md b/README.md index 1b4ad72..8eb6353 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,44 @@ register(BWSt, defineCustomElements).then(() => { }); ``` +## Windows hints + +- Clone the repo: `git clone https://github.com/public-ui/kolibri-theme-bwst.git` +- Use the `Git Bash` +- Install PNPM in Version 9: `npm i -g pnpm^9` +- Node-Version: `node -v` -> Output: `v20.12.2` +- PNPM-Version: `pnpm -v` -> Output: `9.0.6` +- Repo irectory: `pnpm i` + +```bash +Packages: +1305 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +Progress: resolved 1305, reused 1304, downloaded 1, added 1305, done +node_modules/.pnpm/chromedriver@124.0.1/node_modules/chromedriver: Running install script, done in 3.2s + +devDependencies: ++ @public-ui/components 2.1.1 ++ @public-ui/visual-tests 2.1.1 ++ @rollup/plugin-commonjs 25.0.8 ++ @rollup/plugin-node-resolve 15.2.3 ++ @rollup/plugin-typescript 11.1.6 ++ @types/node 20.12.8 ++ @typescript-eslint/eslint-plugin 7.11.0 ++ @typescript-eslint/parser 7.11.0 ++ eslint 8.57.0 ++ nodemon 3.1.2 ++ npm-check-updates 16.14.20 ++ postcss 8.4.38 ++ prettier 3.2.5 ++ rollup 4.18.0 ++ rollup-plugin-postcss 4.0.2 ++ sass 1.77.3 ++ typescript 5.4.5 +``` + +- Start dev: `npm start` +- Edit files + ## Full documentation 👉 [https://public-ui.github.io](https://public-ui.github.io) @@ -29,23 +67,23 @@ Das Default-Theme ist ein _Token-Based_ Theme, das mit minimalen Anpassungen sof ### Variablen -| Variable | Standard-Wert | Bedeutung | -| --------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------- | -| `--kolibri-border-radius` | `5px` | Border-Radius für abgerundete Elemente | +| Variable | Standard-Wert | Bedeutung | +| --------------------------------- | ------------------------------------------------ | -------------------------------------------------- | +| `--kolibri-border-radius` | `5px` | Border-Radius für abgerundete Elemente | | `--kolibri-font-family` | `Calibri, Verdana, Arial, Helvetica, sans-serif` | Allgemeine Schriftart | -| `--kolibri-font-size` | `16px` | Allgemeine Schriftgröße | -| `--kolibri-spacing` | `0.25rem` | Allgemeiner Abstand zwischen Elementen | -| `--kolibri-border-width` | `1px` | Allgemeine Rahmen-Breite | -| `--kolibri-color-primary` | `#004b76` | Primärfarbe | -| `--kolibri-color-primary-variant` | `#0077b6` | Alternative Variante der Primärfarbe | -| `--kolibri-color-danger` | `#c0003c` | Farbe für Fehlermeldungen und gefährliche Aktionen | -| `--kolibri-color-warning` | `#c44931` | Farbe für Warnungen | -| `--kolibri-color-success` | `#005c45` | Farbe für Erfolgsmeldungen | -| `--kolibri-color-subtle` | `#576164` | Farbe für feine Akzente wie z.B. Rahmen | -| `--kolibri-color-light` | `#ffffff` | Helle Farbe für z.B. Hintergründe | -| `--kolibri-color-text` | `#202020` | Textfarbe | -| `--kolibri-color-mute` | `#f2f3f4` | Farbe für deaktivierte Elemente | -| `--kolibri-color-mute-variant` | `#bec5c9` | Alternative Farbe für deaktivierte Elemente | +| `--kolibri-font-size` | `16px` | Allgemeine Schriftgröße | +| `--kolibri-spacing` | `0.25rem` | Allgemeiner Abstand zwischen Elementen | +| `--kolibri-border-width` | `1px` | Allgemeine Rahmen-Breite | +| `--kolibri-color-primary` | `#004b76` | Primärfarbe | +| `--kolibri-color-primary-variant` | `#0077b6` | Alternative Variante der Primärfarbe | +| `--kolibri-color-danger` | `#c0003c` | Farbe für Fehlermeldungen und gefährliche Aktionen | +| `--kolibri-color-warning` | `#c44931` | Farbe für Warnungen | +| `--kolibri-color-success` | `#005c45` | Farbe für Erfolgsmeldungen | +| `--kolibri-color-subtle` | `#576164` | Farbe für feine Akzente wie z.B. Rahmen | +| `--kolibri-color-light` | `#ffffff` | Helle Farbe für z.B. Hintergründe | +| `--kolibri-color-text` | `#202020` | Textfarbe | +| `--kolibri-color-mute` | `#f2f3f4` | Farbe für deaktivierte Elemente | +| `--kolibri-color-mute-variant` | `#bec5c9` | Alternative Farbe für deaktivierte Elemente | ### Verwendung diff --git a/package.json b/package.json index cb0302a..73f22f1 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,7 @@ "ncu:patch": "ncu -t patch -u", "prepack": "pnpm build", "start": "npm-run-all --parallel dev serve", - "serve": "cross-env THEME_MODULE=\"`pwd`/dist\" THEME_EXPORT=BWSt npm --prefix \"node_modules/@public-ui/sample-react/\" start", + "serve": "sh serve.sh", "xtest": "THEME_MODULE=dist THEME_EXPORT=BWSt kolibri-visual-test", "xtest-update": "THEME_MODULE=dist THEME_EXPORT=BWSt kolibri-visual-test --update-snapshots theme-snapshots.spec.js", "pretest": "pnpm build", diff --git a/serve.sh b/serve.sh new file mode 100644 index 0000000..07a7077 --- /dev/null +++ b/serve.sh @@ -0,0 +1,6 @@ +#! /usr/bin/env bash + +export THEME_MODULE="`pwd`/dist" +export THEME_EXPORT=BWSt +cd node_modules/@public-ui/sample-react/ +npm start