Welcome to @thepokencompany/ui 👋

🚀 Usage

Install

Generate a token with the read:packages permission here

Add the following lines to your .npmrc (usually located at ~/.npmrc)

@thepokencompany:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:always-auth=true
//npm.pkg.github.com/:_authToken=YOUR_TOKEN

yarn add @thepokencompany/ui

Inside tailwind.config.js

const rpuiConfig = require('@thepokencompany/ui/config')

module.exports = rpuiConfig({
  purge: [],
  theme: {
    extend: {},
  },
  variants: {},
  plugins: [],
})

rpuiConfig contains default config of the design system but you can still override them.

You can find an usage example here.

🤓 Test in local

yarn build
yarn link

In targeted local repository

yarn link "@thepokencompany/ui"

🎨 Run storybook

yarn start

✨ Format code style

yarn format

🚀 Deploy package

npm version [<newversion> | major | minor | patch]
git push origin main --tags