Internal services for building the Carbon Design System.
This project is built using a collection of packages all built in the same git repository. You might have heard this setup described as a monorepo.
As a result, we use two pieces of tooling to help us managing installing dependencies and publishing our packages. These include:
- Yarn workspaces for handling dependencies across all packages
- Lerna for publishing packages, tagging versions, and more
In order for you to install all the dependencies in this project, you'll need to install Yarn and run the following command in your terminal while using Node v10:
yarn install --frozen-lockfile
Note: the current Node.js version of the project is specied in the engines
field of package.json
This will install all of the dependencies for every package in our project. In addition, it allows us to link between packages that we are developing.
Next up, you'll most likely want to build all of the package files so that things don't fail while you are working on a package. To do this, you can run the following command:
yarn build
Afterwards, you should be good to go! Look at each individual package or service's README.md file for more instructions.
We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation. If you're interested, definitely check out our Contributing Guide ! 👀
Licensed under the Apache 2.0 License.