1 | ## CORE CSS ![npm](https://img.shields.io/npm/v/@procore/core-css.svg) ![npm](https://img.shields.io/npm/dt/@procore/core-css.svg)
|
2 |
|
3 | An implementation of Procore's Web Design Guidelines.
|
4 |
|
5 | ## Requirements
|
6 |
|
7 | Node 6+
|
8 | NPM or Yarn
|
9 |
|
10 | ## Background
|
11 |
|
12 | Our styles are organized according to [`Inverted Triangle CSS`](https://www.xfive.co/blog/itcss-scalable-maintainable-css-architecture/). ITCSS organizes stylesheets by _specificity_. Read the article linked above for more information.
|
13 |
|
14 | ## Developing
|
15 |
|
16 | To get started, type the following from the root directory:
|
17 |
|
18 | ```
|
19 | yarn
|
20 | yarn dev
|
21 | ```
|
22 |
|
23 | ## Testing
|
24 |
|
25 | Testing currently consists of Jest snapshot testing on our React components. To run the test suite use the following command:
|
26 |
|
27 | ```
|
28 | yarn test
|
29 | ```
|
30 |
|
31 | ## Building
|
32 |
|
33 | ```
|
34 | yarn build
|
35 | ```
|
36 |
|
37 | Once the project is done building, the docs can be viewed at `build/docs/index.html`
|
38 |
|
39 | ## Contributing and Styleguide
|
40 |
|
41 | Bug reports and pull requests are welcome on GitHub at https://github.com/procore/core. This project is
|
42 | intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
|
43 | [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
44 |
|
45 | In lieu of a formal styleguide, we use [husky](https://github.com/typicode/husky) to create a `precommit` hook, which executes [prettier](https://github.com/prettier/prettier) on any git staged files determined by [lint-staged](https://github.com/okonet/lint-staged).
|
46 |
|
47 | ## License
|
48 |
|
49 | The package is available under the [Procore Developers License](https://developers.procore.com/terms_and_conditions)
|
50 |
|
51 | ## About Procore
|
52 |
|
53 | <img
|
54 | src="https://www.procore.com/images/procore_logo.png"
|
55 | alt="Procore Logo"
|
56 | width="250px"
|
57 | />
|
58 |
|
59 | CORE Icons is maintained by Procore Technologies.
|
60 |
|
61 | Procore - building the software that builds the world.
|
62 |
|
63 | Learn more about the #1 most widely used construction management software at [procore.com](https://www.procore.com/)
|