Moon Design System
Installing Moon Design
-
corepack enable // Note that we are using pnpm version 8 corepack prepare [email protected] --activate
-
Install dependencies and link local packages together:
pnpm install
-
Compile and build all packages:
pnpm run build
-
Run storybook for development:
pnpm run next dev
-
For Hot Module Replacement run these tasks in parallel:
pnpm run watch
pnpm run next dev
-
Build and run storybook for production at
localhost:80:pnpm run next build
pnpm run next start
Architecture
Our pnpm monorepo publishes key layers as individual @heathmont/moon- packages:
next-docs/- Style guide and documentationworkspaces/- Moon Design Systempackages/- Legacy components, solely for supporting older projects.
Packages are developed inside their respective src folders, utilizing pnpm workspaces for dependency linking/sharing. The distributable code is generated in each package's lib by the TypeScript compiler.
Contributing
If you're interested in contributing to Moon Design, please read our ัontributing docs before submitting a pull request.