Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dfinity/gix-components
A UI kit developed by the GIX team
https://github.com/dfinity/gix-components
designsystem svelte sveltekit ui uikit ux
Last synced: 5 days ago
JSON representation
A UI kit developed by the GIX team
- Host: GitHub
- URL: https://github.com/dfinity/gix-components
- Owner: dfinity
- License: apache-2.0
- Created: 2022-06-20T09:10:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-19T10:48:04.000Z (16 days ago)
- Last Synced: 2024-12-19T11:33:34.610Z (16 days ago)
- Topics: designsystem, svelte, sveltekit, ui, uikit, ux
- Language: Svelte
- Homepage: https://gix.design
- Size: 155 MB
- Stars: 36
- Watchers: 25
- Forks: 7
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# GIX Components
GIX Components is a UI kit developed with [SvelteKit](https://kit.svelte.dev) by the GIX team.
## Getting Started
The component library has been originally implemented for the frontend [dapp](https://nns.ic0.app/) of the Network Nervous System (NNS).
It undergoes continuous improvements, and its showcase and documentation are deployed on the IC: [https://gix.design/](https://gix.design/).
## Installation
Install `gix-components` as a dependency.
```bash
npm i @dfinity/gix-components
```## Packaging
Running `npm run package` bundles the library. It takes the contents of `src/lib` and generate a `dist` directory.
The root directory can be used to consume a local version of `gix-components` in another project (`npm i /../gix-components`).
However, to run 'jest' unit tests in the other project, the library needs to be packed first (`cd package && npm pack`) before being installed (e.g. `npm i /../gix-components/dfinity-gix-components-0.0.1.tgz`).
See [documentation](https://kit.svelte.dev/docs/packaging) for more information.
## Documentation & Showcase
To run the documentation locally, `npm run dev` can be executed.
Running `npm run build` will bundle the showcase. It should be executed before deploying the documentation to a canister smart contract.
Note: all pages of the application are set to be pre-rendered per default.