@unwrapdev/library
Version:
UI Kit + Utils Library.
59 lines (41 loc) • 1.16 kB
Markdown
# Unwrap Dev Library
This project contains a UI Kit and Utils library
## Available Scripts
In the project directory, you can run:
`yarn storybook`
### Deploy Guide:
`yarn build-dist`
`npm publish --access public`
### Website Install Guide:
Install next-transpile-modules
`npm install next-transpile-modules`
Add it to your `next.config.js`
```js
/** @type {import('next').NextConfig} */
const withTM = require('next-transpile-modules')(['@unwrapdev/library']); // pass the modules you would like to see transpiled
const nextConfig = {
reactStrictMode: true,
}
module.exports = withTM(nextConfig)
```
Update your tailwind `content` field
```js
const defaultTheme = require('tailwindcss/defaultTheme');
const unwrapTheme = require("@unwrapdev/library/tailwind.config");
module.exports = {
content: ['./src/**/*.{js,jsx}', './node_modules/@unwrapdev/library/dist/components/**/*.tsx'],
theme: {
...unwrapTheme.theme,
screens: {
xs: '475px',
...defaultTheme.screens,
},
...
},
};
```
Make sure your tailwind supports a primary and secondary color shades
Install Shadcn (radix)
### TODO
1. Host on vercel
2. Add contentful support