https://github.com/onmax/nimiq-ui
https://github.com/onmax/nimiq-ui
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/onmax/nimiq-ui
- Owner: onmax
- Created: 2023-11-20T14:20:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-25T06:13:08.000Z (about 1 year ago)
- Last Synced: 2025-04-10T05:02:53.786Z (about 1 year ago)
- Language: CSS
- Homepage: https://onmax.github.io/nimiq-ui/
- Size: 11.8 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nimiq UI
Design system and component library for the Nimiq blockchain ecosystem. Built as a monorepo with pnpm workspaces, providing CSS frameworks, Vue components, icons, and documentation tools.
## Packages
- **[nimiq-css](./packages/nimiq-css)** - Main CSS framework with design tokens and UnoCSS presets
- **[nimiq-icons](./packages/nimiq-icons)** - Icon system with Figma integration
- **[nimiq-vitepress-theme](./packages/nimiq-vitepress-theme)** - Custom VitePress theme
- **[nimiq-theme](./packages/nimiq-theme)** - Theme utilities
- **[nimiq-maplibre-styles](./packages/nimiq-maplibre-styles)** - Map styling
## Quick Start
```bash
# Install dependencies
pnpm install
# Start development servers
pnpm dev
# Run documentation site
pnpm docs
```
## Development
```bash
# Build all packages
pnpm build
# Run tests
pnpm test
# Lint and fix
pnpm lint:fix
# Type checking
pnpm typecheck
```
## Key Features
- **UnoCSS-based** - Custom presets with design tokens
- **CSS Layers** - Organized preflights, colors, fonts, utilities, typography, and static content
- **Dark/Light Mode** - Built-in theme support
- **Vue 3** - TypeScript components with `Nq*` naming convention
- **Icon System** - Auto-generated from Figma designs via API
- **Documentation** - VitePress with interactive component demos
## Architecture
Built with modern tooling:
- **Build**: Unbuild for libraries, Vite for development
- **Frontend**: Vue 3 with TypeScript
- **CSS**: UnoCSS with custom presets
- **Docs**: VitePress with custom Nimiq theme
- **Testing**: Vitest with JSDOM
## Release
```bash
pnpm release
```
## Documentation
Full documentation available at the docs site. Run `pnpm docs` to view locally.
## License
See individual packages for license information.