@mon-studios/collectfun-ui
v1.0.2
Published
CollectFun UI Kit by Liquidx Studios
Keywords
Readme
CollectFUN UI
CollectFUN UI is the design system and library in use at Mon Protocol to build our collectFun app.
Introduction
CollectFUN UI is built as a React library, using Shadcn as the base components.
We use Storybook for documenting and displaying our components. A cloud hosted version of storybook is available at https://collectfun-ui.vercel.app/
Under the hood, we use Typescript + Vite for builds and TailwindCSS for styling.
Getting Started as a Contributor
Installation
- Before installing, please ensure you have PNPM installed locally.
Install the relevant packages
pnpm installStart your local storybook instance
pnpm run storybook
Publishing to NPM
Our package is hosted on NPM: https://www.npmjs.com/package/@mon-studios/collectfun-ui
While our CI/CD is being configured, all publishing will be done manually.
- You will require write access from one of our package maintainers
If you have access, you may publish via:
# if necessary npm version <major|minor|patch> npm publish --access public
Sync Library with Other Projects Locally
This library can be run locally with other local projects to avoid re-publishing the NPM package to review changes on the other project.
- In this library:
pnpm reload-dev:collectfun-ui- In other projects using this library:
- use
file:protocol to link packages
- use
pnpm add file:../collectfun-ui- reload package dependencies
