Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 2.5 KB

README.md

File metadata and controls

60 lines (40 loc) · 2.5 KB

coreproject-moe/monorepo

GitHub Actions Workflow Status GitHub contributors GitHub License GitHub Issues or Pull Requests Website

JS monorepo for @coreproject-moe powered by nx.

Packages

The monorepo contains the following package:

Package Description
@coreproject-moe/icons A webcomponent based Icon pack library for coreproject-moe.

Note: Each package has its own README.md with detailed documentation on usage and APIs.

Getting Started

To contribute to this monorepo or use its packages in your project, follow these setup steps:
Clone the monorepo:

git clone https://github.com/coreproject-moe/monorepo.git coreporject-monorepo
cd coreporject-monorepo

Install dependencies:

npm install --verbose

Development

To build all packages within the monorepo: pnpm run build
To start a local development environment for all packages: pnpm run dev

Scripts

Here's a brief explanation of the scripts available in the root package.json:

  • build: Builds all packages using nx.
  • changelog: Adds a changeset to generate changelog and version updates.
  • dev: Runs all packages in development/watch mode.
  • format: Formats the codebase using Prettier.
  • lint: Lints the codebase using ESLint.
  • test: Runs tests across all packages.

For a full list of available scripts, see the scripts section in package.json.

Contributing

We welcome contributions to any of the packages in this monorepo. Please read our Contributing Guidelines and our Code of Conduct to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to the project.

License

MIT © CoreProject