@satori-sdk/component-library

Satori Component Library

This is a React component library used by Satori apps. The following components are included in this library:

• AvatarPicker: component for displaying avatars and picker component for choosing name/avatar combo
• CopyButton: Copy button component
• Mini Web Console: a mini Satori console for displaying RTM messages
• Share: component for sharing links or other texts. When clicked, display an overlay containing the CopyButton
• GitHubButton - component for Go to GitHub repo button.
• SignUpButton - component for Sign Up button for satori dev portal.
• SatoriLogo - component for Satori logo image.
• AppShell - component for app shell with common styles.
• AppHeader - component for app header with Logo, GitHub and SignUp buttons.

Getting Started

To run locally:

1. clone the repo
2. yarn install && npm run storybook

To use the components:

1. install: npm i @satori-sdk/component-library
2. import modules to use: import { CopyButton, AvatarPicker } from '@satori-sdk/component-library';
3. follow examples in storybook

To publish package:

1. npm login using satori-sdk user
2. npm run publish-<version> where <version> can be major, minor or patch.