iCHEF web components library, built with React.
APACHE-2.0 License
iCHEF web components library, built with React.
yarn add @ichef/gypcrete
Here is a quick example to get you started:
./App.js
import React from 'react';
import { createRoot } from 'react-dom/client';
import CustomComponent from './CustomComponent';
import '@ichef/gypcrete/dist/gypcrete.css';
const App = () => (
<div>
<CustomComponent />
</div>
);
const container = document.getElementById('app');
const root = createRoot(container);
root.render(<App />);
./CustomComponent.js
import React from 'react';
import { Button } from '@ichef/gypcrete';
const CustomComponent = () => <Button basic="Hello World!" />;
export default CustomComponent;
Gypcrete is a multi-package mono-repo built on Lerna. All sub-pacakges are placed inside packages/
folder. It uses Yarn Workspaces to hoist all dependencies to root level.
To install dependencies and link packages, simply run yarn install
.
To run the Storybook locally, use the yarn start
script.
Linters and test runners are configured at repository level.
They should check all source files across every package in the packages/
folder.
Gypcrete does not publish develop builds to the dist
branch anymore. It now publishes to NPM instead:
develop
branch --> publish a canary buildmaster
branch --> publish a relase buildrelease/x.y.z
,例如 release/1.2.3
。x.y.z
的部分為欲發佈的版號,必須符合 semantic versioning。master
。yarn changelog
更新 CHANGELOG.mdThis project is licensed under the terms of the Apache License 2.0