nebula

README

Sonr UI Components

A specialized fork of Shoelace customized for the Sonr Network, focusing on cryptocurrency and blockchain interfaces.

A tailored web components library for blockchain applications.

• Custom crypto-focused icon library 🪙
• Sonr design system integration 🎨
• Specialized components for blockchain UIs 🔗
• Works with all frameworks 🧩
• Built with accessibility in mind ♿️
• Open source 😸

Originally designed by Cory LaViska, customized for Sonr Network.

---

Documentation: docs.sonr.io/design

Source: github.com/onsonr/styles

Twitter: @sonr_io

---

Shoemakers 🥾

Shoemakers, or "Shoelace developers," can use this documentation to learn how to build Shoelace from source. You will need Node >= 14.17 to build and run the project locally.

You don't need to do any of this to use Shoelace! This page is for people who want to contribute to the project, tinker with the source, or create a custom build of Shoelace.

If that's not what you're trying to do, the documentation website is where you want to be.

How are Sonr components built?

Components are built with LitElement for reactive web components, integrated with Sonr's design system and custom icon libraries specifically created for cryptocurrency and blockchain interfaces. The build process uses esbuild for efficient bundling.

Forking the Repo

Start by forking the repo on GitHub, then clone it locally and install dependencies.

git clone https://github.com/YOUR_GITHUB_USERNAME/shoelace
cd shoelace
npm install

Developing

Once you've cloned the repo, run the following command.

npm start

This will spin up the dev server. After the initial build, a browser will open automatically. There is currently no hot module reloading (HMR), as browser's don't provide a way to reregister custom elements, but most changes to the source will reload the browser automatically.

Building

To generate a production build, run the following command.

npm run build

Creating New Components

To scaffold a new component, run the following command, replacing sl-tag-name with the desired tag name.

npm run create sl-tag-name

This will generate a source file, a stylesheet, and a docs page for you. When you start the dev server, you'll find the new component in the "Components" section of the sidebar.

Contributing

Shoelace is an open source project and contributions are encouraged! If you're interesting in contributing, please review the contribution guidelines first.

License

Shoelace was created by Cory LaViska and is available under the terms of the MIT license.

Whether you're building Shoelace or building something with Shoelace — have fun creating! 🥾