1 | ## CORE React ![npm](https://img.shields.io/npm/v/@procore/core-react.svg) ![npm](https://img.shields.io/npm/dt/@procore/core-react.svg)
|
2 |
|
3 | A set of React components implementing the `core-css` spec.
|
4 |
|
5 | ## Requirements
|
6 |
|
7 | Node 10+
|
8 | NPM or Yarn
|
9 |
|
10 | #### Peer Dependencies
|
11 |
|
12 | `react@^16.8.0`
|
13 | `react-dom@^16.8.0`
|
14 |
|
15 | ## Developing
|
16 |
|
17 | To get started, type the following from the root directory:
|
18 |
|
19 | ```
|
20 | yarn
|
21 | yarn dev
|
22 | ```
|
23 |
|
24 | ## Testing
|
25 |
|
26 | Testing currently consists of Jest snapshot testing on our React components. To run the test suite use the following command:
|
27 |
|
28 | ```
|
29 | yarn test
|
30 | ```
|
31 |
|
32 | Note that `core-react` requires `react-utils` to be built before running tests.
|
33 |
|
34 | ## Building
|
35 |
|
36 | ```
|
37 | yarn build
|
38 | ```
|
39 |
|
40 | ## Contributing and Styleguide
|
41 |
|
42 | Bug reports and pull requests are welcome on GitHub at https://github.com/procore/core. This project is
|
43 | intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
|
44 | [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
45 |
|
46 | In lieu of a formal styleguide, we use [husky](https://github.com/typicode/husky) to create a `precommit` hook, which executes [lint-staged](https://github.com/okonet/lint-staged) to automatically format any git staged files using [prettier](https://github.com/prettier/prettier).
|
47 |
|
48 | ## License
|
49 |
|
50 | The package is available under the [Procore Developers License](https://developers.procore.com/terms_and_conditions)
|
51 |
|
52 | ## About Procore
|
53 |
|
54 | <img
|
55 | src="https://www.procore.com/images/procore_logo.png"
|
56 | alt="Procore Logo"
|
57 | width="250px"
|
58 | />
|
59 |
|
60 | CORE Icons is maintained by Procore Technologies.
|
61 |
|
62 | Procore - building the software that builds the world.
|
63 |
|
64 | Learn more about the #1 most widely used construction management software at [procore.com](https://www.procore.com/)
|