Skip to content
This repository has been archived by the owner on Feb 15, 2025. It is now read-only.

Add Windows support #6

Merged
merged 3 commits into from
May 31, 2024
Merged

Add Windows support #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7faf036
Fix Windows support by using an external serve script that allows eva…
sdvg May 31, 2024
343c53d
Fix remaining Windows compat issues
sdvg May 31, 2024
619b361
docs: add windows readme
deleonio May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 54 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
6 changes: 6 additions & 0 deletions serve.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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