Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 862 Bytes

README.md

File metadata and controls

37 lines (28 loc) · 862 Bytes

Material-Me

Material-Me is a front-end Web Components library designed with reference to Material You.

Material-Me 是一个前端 Web Components 库，其设计参考了 Material You。

NOTE: This library is still in WIP, do not use it for production.
注意：该库仍处于 WIP 状态，请勿将其用于生产。

Development

prerequisites:

  • Git installed
  • Node.js installed (preferably >= 22.1.0)
  • pnpm installed (preferably >= 8)
# clone the repo or your fork
git clone https://github.com/lingbopro/material-me.git
cd material-me
# install dependencies
pnpm install
# set up hooks
pnpm prepare
# do some modifications...

# build the project
pnpm build
# commit your changes
# NOTE: message should follow the Conventional Commits specification
# see commitlint.config.js
git commit -m ...
# push
git push