@procore/core-css

CORE-CSS

Atomic CSS

What is this?

CORE-CSS is a minimalist implementation of Procore's Web Design Guidelines. The library provides:

• Styles
• SCSS source files

Requirements

Node 6+ NPM or Yarn

Developing

To get started, type the following from the root directory:

yarn
yarn dev

Once the webpack build server is running, you can view the styles at http://localhost:5000.

Our styles are organized according to Inverted Triangle CSS. ITCSS organizes stylesheets by specificity. Read the article linked above for more information.

Linting and Pre-Commit Hook

We use lint-staged to automatically format our source files via husky's precommit hook. This process is configured in the .lintstagedrc file and in the precommit entry of package.json

Testing

Testing currently consists of Jest snapshot testing on our React storybook components. To run the test suite use the following command:

yarn test

Building

yarn build

Publishing

yarn publish

Contributing

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.

1. Create PR
2. Merge PR and pull master locally
3. npm version minor
4. npm run endpoints && npm run compile
5. npm publish

License

The package is available as open source under the terms of the MIT License.

About Procore

Core-CSS 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