Welcome to contribute! Please take a moment to read this guide before getting started.
Please ensure that Node.js is installed. After cloning the project, use npm install to install dependencies, then use npm run dev to start the project.
npm install
npm run dev
# open http://localhost:8000This project integrates component library compilation and documentation, so no additional work is needed. You can check package.json for more information.
This project uses the following tech stack:
- dumi for generating static documentation. Similar to Docusaurus or Storybook
- father for component library bundling
- React-JSS for component library styling
- ahooks commonly used hooks
- clsx utility library for fast
classNamemanipulation - lodash utility library
-
src
Component directory
-
Button
-
demos
Component demos
- index.md Component documentation
- Button.tsx Component source code
-
demos
Component demos
-
Button
- docs Other page documentation
- .dumirc.ts Documentation related configuration
For more information, please refer to dumi documentation: Conventional Routing
The API design is primarily based on Ant Design and React Bootstrap. The styling aims to be consistent with PaperCSS. All features listed on PaperCSS are included, with additional advanced usage patterns.
Besides the components listed on the official website, there are also some components planned for development. You can check ROADMAP for more information.