{"id":19626113,"url":"https://github.com/deepsourcecorp/zeal","last_synced_at":"2025-04-28T05:33:13.236Z","repository":{"id":65941099,"uuid":"285349749","full_name":"DeepSourceCorp/zeal","owner":"DeepSourceCorp","description":"Component library for DeepSource's Zeal design system.","archived":false,"fork":false,"pushed_at":"2023-07-31T06:21:28.000Z","size":3950,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-10T05:11:31.461Z","etag":null,"topics":["design","vue"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DeepSourceCorp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-05T16:44:03.000Z","updated_at":"2023-07-07T12:13:25.000Z","dependencies_parsed_at":"2024-10-05T00:33:50.676Z","dependency_job_id":"e4903a1f-7f09-488c-9851-5a79f6bc85c6","html_url":"https://github.com/DeepSourceCorp/zeal","commit_stats":{"total_commits":1188,"total_committers":24,"mean_commits":49.5,"dds":0.7365319865319866,"last_synced_commit":"30c3fbeaf81fd7b9ffecc1934ea8dc82014fea6f"},"previous_names":["deepsourcecorp/zeal","deepsourcelabs/zeal"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepSourceCorp%2Fzeal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepSourceCorp%2Fzeal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepSourceCorp%2Fzeal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepSourceCorp%2Fzeal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DeepSourceCorp","download_url":"https://codeload.github.com/DeepSourceCorp/zeal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224098471,"owners_count":17255508,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["design","vue"],"created_at":"2024-11-11T11:44:59.833Z","updated_at":"2024-11-11T11:45:00.469Z","avatar_url":"https://github.com/DeepSourceCorp.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# Zeal\n\n[![DeepSource](https://app.deepsource.com/gh/DeepSourceCorp/zeal.svg/?label=active+issues\u0026show_trend=true\u0026token=omkRhJZzuS3w0dBXsP_rrwNH)](https://app.deepsource.com/gh/DeepSourceCorp/zeal/?ref=repository-badge)[![DeepSource](https://app.deepsource.com/gh/DeepSourceCorp/zeal.svg/?label=resolved+issues\u0026show_trend=true\u0026token=omkRhJZzuS3w0dBXsP_rrwNH)](https://app.deepsource.com/gh/DeepSourceCorp/zeal/?ref=repository-badge)\n\n  \u003cp\u003eZeal is the component system used across DeepSource Assets\u003c/p\u003e\n\n\u003c/div\u003e\n\n## Using in another library\n\n#### Setting up tailwind\n\nAdd this in the tailwind.config.js\n\n```javascript\n// tailwind.config.js\nmodule.exports = {\n  // import the tailwind config from Zeal.\n  presets: [require('@deepsourcelabs/zeal/tailwind.config')],\n  // Don't purge zeal styles\n  purge: {\n    enabled: true,\n    content: ['./pages/**/*', './components/**/*', './node_modules/@deepsourcelabs/**/*.vue']\n  }\n}\n```\n\n## Dev setup\n\n### Required Versions\n\n1. Node: v14@latest\n2. yarn: v1\n\n### Local setup instructions\n\n1. Clone the Repo using `git clone https://github.com/DeepSourceCorp/zeal`\n2. Run `yarn` to install all dependencies\n3. Run `yarn storybook:serve` to run the dev server and storybook for development\n\n### Building the library\n\nThe following NPM scripts help building the library\n\n1. **`yarn build-lib`**: This will build the library with `main.ts` as the input file\n2. **`yarn build-storybook`**: This will build the Storybook\n3. **`yarn build_icons`**: This will fetch the svg icons from the `src/icons` and build a JSON file\n4. **`yarn build:css`**: This will run post css and generate the CSS files for tailwind and other components\n5. **`yarn build-lib-icons`**: This will build the library, css files and the icons\n\n### Publishing\n\nBefore you begin, ensure you have the `.npmrc` file setup.\n\n1. Bump the version in `package.json` and commit that change\n2. Remove `private: true` from the `package.json` (revert after publishing)\n3. Run `yarn test:unit \u0026\u0026 yarn build-lib-icons`\n4. On successful test and build run `npm publish`\n\n\u003e Note: Add `private: true` back after publishing. In CI, don't forget to run yarn before step 3\n\n## Adding icons\n\n1. For generic icons, replace all custom colors added to the SVG file with `currentColor`\n2. Optimize the SVG using [SVGOMG](https://jakearchibald.github.io/svgomg/)\n3. Create a new SVG file unde the `src/icons` folder and paste the optimized SVG into it\n4. Run `yarn build_icons` to update the `icons.json` file\n5. Verify the icons look alright by starting the storybook locally using `yarn storybook:serve`\n6. Make a pull request for it with the screenshots of the icon preview in storybook\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepsourcecorp%2Fzeal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeepsourcecorp%2Fzeal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepsourcecorp%2Fzeal/lists"}