maze/cyberduck
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Streamline package

Browse Source
This commit is contained in:
maze
2026-03-10 10:29:45 +01:00
parent 6d150a9468
commit 10b8cf9285
3 changed files with 83 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -23,6 +23,15 @@ npm install git+https://git.maze.io/maze/cyberduck.git#main
Note: when installing from a git repository, npm will clone the source. For consumers to get built artifacts (the `dist` bundle and compiled types) the repository must either include the `dist` output or provide a `prepare`/build step that runs on install. If you prefer not to publish, using `npm pack` from the repo owner (tarball) ensures the built `dist` is included.
Git install prerequisites
When a consumer installs the package directly from the Git repository, npm (and yarn) will run the package `prepare` script to produce the built `dist` and type artifacts. That means the consumer environment must be able to run the build:
- Have Node.js and npm installed (recommended Node 16+).
- Have a working `npm install` that can fetch devDependencies so the build tools (`typescript`, `sass`, `vite`) are available.
If you don't want consumers to run the build during install, either include the `dist` output in the repository (not recommended) or distribute a tarball produced by `npm pack` from the author so consumers can install the built package without running `prepare`.
## Including styles (optional)
Styles are optional — CyberDuck does not automatically inject styles when you import components. Import styles only if you want the theme and utilities applied.