Skip to content

Component library for DeepSource's Zeal design system.

License

Notifications You must be signed in to change notification settings

DeepSourceCorp/zeal

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date
Feb 21, 2023
Aug 17, 2021
Dec 17, 2020
Mar 6, 2023
Feb 21, 2023
Dec 1, 2020
Jul 2, 2021
Sep 25, 2020
Mar 6, 2023
Jan 6, 2021
Dec 8, 2020
Jun 2, 2022
Dec 8, 2022
Jun 5, 2021
Feb 10, 2023
Sep 16, 2020
Dec 29, 2020
Dec 1, 2020
Feb 21, 2023
Dec 22, 2020
Nov 7, 2022
Jan 12, 2021
Nov 29, 2022

Repository files navigation

Zeal

DeepSource DeepSource

Zeal is the component system used across DeepSource Assets

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

  1. Node: v14@latest
  2. yarn: v1

Local setup instructions

  1. Clone the Repo using git clone https://github.com/deepsourcelabs/zeal
  2. Run yarn to install all dependencies
  3. Run yarn storybook:serve to run the dev server and storybook for development

Building the library

The following NPM scripts help building the library

  1. yarn build-lib: This will build the library with main.ts as the input file
  2. yarn build-storybook: This will build the Storybook
  3. yarn build_icons: This will fetch the svg icons from the src/icons and build a JSON file
  4. yarn build:css: This will run post css and generate the CSS files for tailwind and other components
  5. yarn build-lib-icons: This will build the library, css files and the icons

Publishing

Before you begin, ensure you have the .npmrc file setup.

  1. Bump the version in package.json and commit that change
  2. Remove private: true from the package.json (revert after publishing)
  3. Run yarn test:unit && yarn build-lib-icons
  4. 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