A set of React components implementing the core-css
spec.
Requirements
Node 10+ NPM or Yarn
Peer Dependencies
react@^16.8.0
react-dom@^16.8.0
Developing
To get started, type the following from the root directory:
yarn
yarn dev
Testing
Testing currently consists of Jest snapshot testing on our React components. To run the test suite use the following command:
yarn test
Note that core-react
requires react-utils
to be built before running tests.
Building
yarn build
Contributing and Styleguide
Bug reports and pull requests are welcome on GitHub at https://github.com/procore/core. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
In lieu of a formal styleguide, we use husky to create a precommit
hook, which executes lint-staged to automatically format any git staged files using prettier.
License
The package is available under the Procore Developers License
About Procore
CORE Icons is maintained by Procore Technologies.
Procore - building the software that builds the world.
Learn more about the #1 most widely used construction management software at procore.com