https://github.com/impierce/ui-components
UI component library for Impierce projects
https://github.com/impierce/ui-components
Last synced: about 1 year ago
JSON representation
UI component library for Impierce projects
- Host: GitHub
- URL: https://github.com/impierce/ui-components
- Owner: impierce
- Archived: true
- Created: 2023-02-23T17:43:14.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-12-06T00:24:29.000Z (over 2 years ago)
- Last Synced: 2025-03-01T00:12:54.590Z (over 1 year ago)
- Language: Svelte
- Size: 1.92 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Impierce UI Component Library
This component library uses [shadcn-svelte](https://www.shadcn-svelte.com) for the underlying components and then applies custom styling.
The raw components (`npx shadcn-svelte add ...`) are located in `src/lib/components/ui`.
Note: some components that do not exist in shadcn-svelte yet have been imported from [svelte-headlessui](https://captaincodeman.github.io/svelte-headlessui).
## Local development
```bash
npm install
npm run storybook
```
> Go to http://localhost:6006 to see a live preview of the components!
```bash
npm run dev
```
> Go to http://localhost:3000 to browse through pre-defined user flows (mock data)
## Build
```bash
npm run build-storybook
npx http-server storybook-static
```
> Go to http://localhost:8081 and explore the final components!
## Release
> The release is currently **not** automated or generated.
1. Adjust the version in `package.json`
2. Go to **GitHub > Releases > Draft a new release**
3. Create the next tag (according to the version)
4. Set the release title to the same name
5. Publish
6. A GitHub workflow will be triggered that tests, builds and publishes the version
## Use a released version
```bash
# https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
# GitHub > Settings > Developer settings > Personal access tokens > Tokens (classic)
# Note: Read private packages, Expiration: 90 days, Scopes: read:packages
touch ~/.npmrc
//npm.pkg.github.com/:_authToken=ghp_...
```