{"id":15297118,"url":"https://github.com/ichef/gypcrete","last_synced_at":"2025-08-26T12:16:57.290Z","repository":{"id":22375880,"uuid":"83007597","full_name":"iCHEF/gypcrete","owner":"iCHEF","description":"iCHEF web components library, built with React.","archived":false,"fork":false,"pushed_at":"2025-01-17T04:16:54.000Z","size":14988,"stargazers_count":30,"open_issues_count":16,"forks_count":2,"subscribers_count":16,"default_branch":"develop","last_synced_at":"2025-04-09T15:01:27.366Z","etag":null,"topics":["javascript","react","react-components","storybook"],"latest_commit_sha":null,"homepage":"https://ichef.github.io/gypcrete/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iCHEF.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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":"2017-02-24T06:08:12.000Z","updated_at":"2024-05-31T06:07:20.000Z","dependencies_parsed_at":"2023-02-15T09:16:17.845Z","dependency_job_id":"e70a1257-8dbd-4a8f-a3f7-786975850c83","html_url":"https://github.com/iCHEF/gypcrete","commit_stats":{"total_commits":1624,"total_committers":17,"mean_commits":95.52941176470588,"dds":0.3879310344827587,"last_synced_commit":"00d499752c957dc43c45adf2c28213773dfebc8f"},"previous_names":[],"tags_count":66,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iCHEF%2Fgypcrete","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iCHEF%2Fgypcrete/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iCHEF%2Fgypcrete/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iCHEF%2Fgypcrete/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iCHEF","download_url":"https://codeload.github.com/iCHEF/gypcrete/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248055276,"owners_count":21040156,"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":["javascript","react","react-components","storybook"],"created_at":"2024-09-30T19:15:13.248Z","updated_at":"2025-04-09T15:03:53.293Z","avatar_url":"https://github.com/iCHEF.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gypcrete\n\niCHEF web components library, built with React.\n\n[![npm package](https://img.shields.io/npm/v/@ichef/gypcrete.svg)](https://www.npmjs.com/package/@ichef/gypcrete)\n[![build status](https://img.shields.io/travis/iCHEF/gypcrete/master.svg)](https://travis-ci.org/iCHEF/gypcrete)\n[![Coverage Status](https://img.shields.io/coveralls/iCHEF/gypcrete/master.svg)](https://coveralls.io/github/iCHEF/gypcrete?branch=master)\n\n[![PeerDependencies](https://img.shields.io/david/peer/iCHEF/gypcrete.svg)](https://david-dm.org/iCHEF/gypcrete?type=peer)\n[![Dependencies](https://img.shields.io/david/iCHEF/gypcrete.svg)](https://david-dm.org/iCHEF/gypcrete)\n[![DevDependencies](https://img.shields.io/david/dev/iCHEF/gypcrete.svg)](https://david-dm.org/iCHEF/gypcrete?type=dev)\n\n## Demo\n\n[ichef.github.io/gypcrete](https://ichef.github.io/gypcrete)\n\n## Installation\n\n```sh\nyarn add @ichef/gypcrete\n```\n\n## Usage\n\nHere is a quick example to get you started:\n\n**./App.js**\n\n```jsx\nimport React from 'react';\nimport { createRoot } from 'react-dom/client';\n\nimport CustomComponent from './CustomComponent';\n\nimport '@ichef/gypcrete/dist/gypcrete.css';\n\nconst App = () =\u003e (\n  \u003cdiv\u003e\n    \u003cCustomComponent /\u003e\n  \u003c/div\u003e\n);\n\nconst container = document.getElementById('app');\nconst root = createRoot(container);\nroot.render(\u003cApp /\u003e);\n```\n\n**./CustomComponent.js**\n\n```jsx\nimport React from 'react';\nimport { Button } from '@ichef/gypcrete';\n\nconst CustomComponent = () =\u003e \u003cButton basic=\"Hello World!\" /\u003e;\n\nexport default CustomComponent;\n```\n\n## Develop\n\nGypcrete is a multi-package mono-repo built on [Lerna](https://github.com/lerna/lerna). All sub-pacakges are placed inside `packages/` folder. It uses [Yarn Workspaces](https://yarnpkg.com/en/docs/workspaces) to hoist all dependencies to root level.\n\nTo install dependencies and link packages, simply run `yarn install`.\nTo run the Storybook locally, use the `yarn start` script.\n\nLinters and test runners are configured at repository level.\nThey should check all source files across every package in the `packages/` folder.\n\nGypcrete does not publish develop builds to the `dist` branch anymore. It now publishes to NPM instead:\n\n- When pushed to `develop` branch --\u003e publish a canary build\n- When pushed to `master` branch --\u003e publish a relase build\n\n## Release\n\n1. 從 develop 開出新的 release branch，release branch 的格式必須符合 `release/x.y.z`，例如 `release/1.2.3`。`x.y.z` 的部分為欲發佈的版號，必須符合 semantic versioning。\n2. 以這支新的 release branch 開出新的 PR，base branch 設為 `master`。\n3. 當 PR 被 merge 時，會觸發 github action 的 [Release workflow](https://github.com/iCHEF/fe-modules/blob/master/.github/workflows/release.yml)，此 workflow 會在 master branch 做下列動作：\n   - 更新 package.json 的 version 並 commit\n   - 執行 `yarn changelog` 更新 CHANGELOG.md\n   - 打 git tag 並將 tag push 上 github\n   - 發佈新版本到 npm\n   - 開出 backport 到 develop branch 的 PR\n4. merge backport PR。至此完成 release 流程。\n\n## LICENSE\n\nThis project is licensed under the terms of the [Apache License 2.0](https://github.com/ichef/gypcrete/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fichef%2Fgypcrete","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fichef%2Fgypcrete","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fichef%2Fgypcrete/lists"}