0.12.39 • Published 9 months ago
@deepsource/zeal v0.12.39
Zeal
Using in another library
Setting up tailwind
Add this in the tailwind.config.js
// tailwind.config.js
module.exports = {
// import the tailwind config from Zeal.
presets: [require('@deepsourcelabs/zeal/tailwind.config')],
// Don't purge zeal styles
purge: {
enabled: true,
content: ['./pages/**/*', './components/**/*', './node_modules/@deepsourcelabs/**/*.vue']
}
}
Dev setup
Required Versions
- Node: v14@latest
- yarn: v1
Local setup instructions
- Clone the Repo using
git clone https://github.com/DeepSourceCorp/zeal
- Run
yarn
to install all dependencies - Run
yarn storybook:serve
to run the dev server and storybook for development
Building the library
The following NPM scripts help building the library
yarn build-lib
: This will build the library withmain.ts
as the input fileyarn build-storybook
: This will build the Storybookyarn build_icons
: This will fetch the svg icons from thesrc/icons
and build a JSON fileyarn build:css
: This will run post css and generate the CSS files for tailwind and other componentsyarn build-lib-icons
: This will build the library, css files and the icons
Publishing
Before you begin, ensure you have the .npmrc
file setup.
- Bump the version in
package.json
and commit that change - Remove
private: true
from thepackage.json
(revert after publishing) - Run
yarn test:unit && yarn build-lib-icons
- On successful test and build run
npm publish
Note: Add
private: true
back after publishing. In CI, don't forget to run yarn before step 3
Adding icons
- For generic icons, replace all custom colors added to the SVG file with
currentColor
- Optimize the SVG using SVGOMG
- Create a new SVG file unde the
src/icons
folder and paste the optimized SVG into it - Run
yarn build_icons
to update theicons.json
file - Verify the icons look alright by starting the storybook locally using
yarn storybook:serve
- Make a pull request for it with the screenshots of the icon preview in storybook
0.12.38
10 months ago
0.12.39
9 months ago
0.12.37
10 months ago
0.12.36
10 months ago
0.12.34
11 months ago
0.12.35
11 months ago
0.12.30
12 months ago
0.12.31
12 months ago
0.12.32
11 months ago
0.12.33
11 months ago
0.12.27
1 year ago
0.12.28
1 year ago
0.12.29
12 months ago
0.12.20
1 year ago
0.12.21
1 year ago
0.12.22
1 year ago
0.12.19
1 year ago
0.12.23
1 year ago
0.12.24
1 year ago
0.12.25
1 year ago
0.12.26
1 year ago
0.12.18
1 year ago
0.12.16
1 year ago
0.12.13
1 year ago
0.12.15
1 year ago
0.12.12
1 year ago
0.12.11
1 year ago
0.12.10
1 year ago