{"id":13760216,"url":"https://github.com/generoi/genero-design-system","last_synced_at":"2025-12-30T06:25:56.758Z","repository":{"id":42370356,"uuid":"263084925","full_name":"generoi/genero-design-system","owner":"generoi","description":null,"archived":false,"fork":false,"pushed_at":"2023-02-22T15:43:58.000Z","size":23049,"stargazers_count":4,"open_issues_count":9,"forks_count":0,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-10-26T11:59:20.179Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://gds.generogrowth.com/","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/generoi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-11T15:38:06.000Z","updated_at":"2023-07-20T02:05:42.000Z","dependencies_parsed_at":"2024-08-03T13:14:38.654Z","dependency_job_id":null,"html_url":"https://github.com/generoi/genero-design-system","commit_stats":{"total_commits":445,"total_committers":16,"mean_commits":27.8125,"dds":0.5460674157303371,"last_synced_commit":"2d06cc157bad2be3ebba706644a56bb712fbdfc6"},"previous_names":[],"tags_count":52,"template":false,"template_full_name":null,"purl":"pkg:github/generoi/genero-design-system","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generoi%2Fgenero-design-system","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generoi%2Fgenero-design-system/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generoi%2Fgenero-design-system/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generoi%2Fgenero-design-system/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/generoi","download_url":"https://codeload.github.com/generoi/genero-design-system/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generoi%2Fgenero-design-system/sbom","scorecard":{"id":422373,"data":{"date":"2025-08-11","repo":{"name":"github.com/generoi/genero-design-system","commit":"2d06cc157bad2be3ebba706644a56bb712fbdfc6"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/29 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Info: FSF or OSI recognized license: MIT License: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"81 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-434g-2637-qmqr","Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m","Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw","Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p","Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747","Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh","Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-33f9-j839-rf8h","Warn: Project is vulnerable to: GHSA-c36v-fmgq-m8hx","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-4wx3-54gh-9fr9","Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-px4h-xg32-q955","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6","Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3","Warn: Project is vulnerable to: GHSA-566m-qj78-rww5","Warn: Project is vulnerable to: GHSA-gj77-59wh-66hg","Warn: Project is vulnerable to: GHSA-hqhp-5p83-hx96","Warn: Project is vulnerable to: GHSA-3949-f494-cm99","Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-w5hq-hm5m-4548","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7","Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T01:32:34.684Z","repository_id":42370356,"created_at":"2025-08-19T01:32:34.687Z","updated_at":"2025-08-19T01:32:34.687Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28005414,"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","status":"online","status_checked_at":"2025-12-24T02:00:07.193Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-08-03T13:01:05.513Z","updated_at":"2025-12-24T17:12:32.677Z","avatar_url":"https://github.com/generoi.png","language":"SCSS","funding_links":[],"categories":["SCSS"],"sub_categories":[],"readme":"# Genero Design System\n\n## Usage\n\n### In vanilla project\n\nUsing lazy loaded ES modules.\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml lang=\"en\"\u003e\n  \u003chead\u003e\n    \u003cscript type=\"module\"\u003e\n      import { applyPolyfills, defineCustomElements } from 'https://unpkg.com/genero-design-system/loader/index.js'\n      \n      applyPolyfills().then(() =\u003e {\n        defineCustomElements()\n      })\n    \u003c/script\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003cgds-button\u003ebutton\u003c/gds-button\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\n### In React projects\n\nInstall GDS to you project.\n\n```sh\nnpm install genero-design-system\n```\n\nAdd this to React App's `index.js` file. More info https://stenciljs.com/docs/react\n\n```js\n// Include global GDS css with css variables.\nimport 'genero-design-system/dist/gds/gds.css'\n\nimport { applyPolyfills, defineCustomElements } from 'genero-design-system/loader'\n\n// applyPolyfills for Edge and IE11. \napplyPolyfills().then(() =\u003e {\n  defineCustomElements()\n})\n```\n\nUse as React components.\n\n```js\nimport { GdsButton } from 'genero-design-system/react'\n\nconst render = () =\u003e {\n  return \u003cGdsButton rightIcon=\"❯\"\u003ebutton\u003c/GdsButton\u003e\n}\n```\n\nUse as web components.\n\n```js\nimport React from 'react'\n\nconst render = () =\u003e {\n  return \u003cdiv\u003e\u003cgds-button right-icon=\"❯\"\u003ebutton\u003c/gds-button\u003e\u003c/div\u003e\n}\n```\n\n### SASS library\n\nThere's no main entrypoint for all mixins, you are instead encouraged to encapsulate all dependencies in the files that they are used.\n\n```scss\n// Import component\n@use '~genero-design-system/src/components/gds-button' as button;\n\n.button {\n  @include button.base;\n}\n```\n\n## Development\n\n```sh\nnpm install\n```\n\nBuild and watch changes. Also checks dependencies for updates.\n\n```sh\nnpm start\n```\n\nRun storybook\n\n```sh\nnpm run storybook\n```\n\n### Creating a new component\n\nUse the `gds-button` component as a basis for the new component.\n\nUse Stencil CLI to generate a new component:\n\n- Component naming example: `gds-my-component`\n- Skip test files for now. We need to think about those later.\n\n```sh\nnpm run generate\n```\n\nNext do the following:\n\n- Copy `gds-button/_index.scss` the the new component's folder.\n- Rename the stylesheet from .css to .scss and use the `gds-button.scss` as a basis.\n- Add a component.stories.js file.\n- Add a README.md file\n\nBuild and watch the component and generate readme.md docs.\nTODO: This should also watch changes in \\_index.scss files.\n\n```sh\nnpm run start\n```\n\n### Style Guide\n\nWhile we don't have our internal Style Guide, let's use the same as Stencil core team: https://stenciljs.com/docs/style-guide\n\n#### CSS\n\n- CSS variables should be used broadly in every component.\n- Naming scheme for variables is `--component-name-size-property-modifier`.\n- Use SASS variables for arbitrary values.\n\n### Docs\n\n- Web Components Best Practices from Google: https://developers.google.com/web/fundamentals/web-components/best-practices\n- On Properties: https://stenciljs.com/docs/properties\n- On Shadow DOM: https://developers.google.com/web/fundamentals/web-components/shadowdom\n\n### Build Storybook\n\nBuild static storybook to /docs folder.\n\n```sh\nnpm run build\nnpm run build:storybook\n```\n\nYou can test static version locally.\n\n```sh\nnpx http-server docs\n```\n\nThe storybooks are automatically built on commits to `master` and when versions are tagged. For now you'll need to edit the[`docs/storybook-config.json`](https://github.com/generoi/genero-design-system/blob/gh-pages/docs/storybook-config.json) file and add versions you want to be displayed. _TODO: this should be done with a script in the github action._\n\nIf you want to manually add a version to the storybooks docs:\n\n```sh\n# Build the storybook\nnpm run build\nnpm run build:storybook\n\n# Clone the gh-pages branch\ngit clone --single-branch -b gh-pages git@github.com:generoi/genero-design-system.git gds-gh-pages\ncd gds-gh-pages\ncp -r ../docs docs/my-custom-build\n\n# Edit the storybook.config.json to include the version\nvim docs/storybook.config.json\n```\n\n\n### Tips, tricks, and gotchas\n\nPlease add here, when you solve something you got stuck at.\n\n- In HTML, attributes need to use dash-case. In JSX you use camelCase.\n- When you add new components, it's best to restart build watcher because it usually breaks here.\n- Use `/public` folder for static assets in stories.\n- Use `/.storybook/preview-head.html` to inject code to all stories globally.\n- Sometimes changes won't reflect in Storybook. If nothing helps try to build with `npm run build:stencil --watch`.\n\nIn React apps:\n\n- When using Stencil component without shadow DOM (`shadow: false`) in a React app, you need to use a unique key for components that are re-rendered when state changes. \n\n### Storybook roadmap\n\n- Add props table: https://github.com/storybookjs/storybook/tree/next/addons/docs/web-components#props-tables\n\n### Commits\n\nCommits will be linted according to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)\n\nyou can also use [commitizen](https://commitizen.github.io/cz-cli/)\n\n```sh\nnpx git-cz\n```\n\nor if you have it installed\n\n```sh\ngit cz\n```\n\n### Using local version of GDS in other projects\n\nYou can use linking to use GDS local repo in other project directly.\n\nGo to GDS local repo.\n\n```sh\nyarn link\n```\n\nGo to you project where you want to use GDS directly.\n\n```sh\nyarn link genero-design-system\n```\n\nPresto!\n\n## Publishing a new version\n\n### Build first\n\nMake sure everything is built.\n\n```sh\nnpm run build\n```\n\n### Create release\n\nAutomatically generates changelog and bumps the version.\n\nBump minor (or patch or major) version:\n\n```sh\nnpm run release -- --release-as minor\n```\n\nor based on commit log:\n\n```sh\nnpm run release\n```\n\nor manually specify the version:\n\n```sh\nnpm run release -- --release-as 1.1.0\n```\n\nor a named prerelease version:\n\n```sh\nnpm run release -- --prerelease beta\n```\n\nPush release commit and tag.\n\n```sh\ngit push\ngit push --tags\n```\n\nSee [conventional-changelog/standard-version#cli-usage](https://github.com/conventional-changelog/standard-version#cli-usage) for more details and examples\n\n\n### Publish release to NPM\n\n```sh\nnpm login\nnpm publish\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeneroi%2Fgenero-design-system","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeneroi%2Fgenero-design-system","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeneroi%2Fgenero-design-system/lists"}