## CORE Icons ![npm](https://img.shields.io/npm/v/@procore/core-icons.svg) ![npm](https://img.shields.io/npm/dt/@procore/core-icons.svg)

A set of SVGs turned into React components.

## Requirements

node 16+
yarn 4+

## Developing

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

```
yarn
yarn run dev
```

## Building

```
yarn run build
```

# Updating Icons from Figma

In Core, we run a script to get updates from the [Figma Icons Production File](https://www.figma.com/design/jIThjA3biHtCR55Q9SJZgz/CORE-Icons--Production-).

1. Clone the repo

2. `cd` to `packages/core-icons` directory

3. Copy and rename `.env.sample` to `.env`

4. Set the `FIGMA_TOKEN` and `GH_TOKEN` variables in the `.env` file. You can get these from Figma and Github.

5. Run the command `yarn update`

6. Follow the prompts, the options are set the recommended/required default values.

7. Commit a changeset, saying what changed.
  
8. Open a pull request with the updated icons.

## 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](http://contributor-covenant.org) code of conduct.

## License

The package is available under the [Procore Developers License](https://developers.procore.com/terms_and_conditions)

## About Procore

<img
  src="https://www.procore.com/images/procore_logo.png"
  alt="Procore Logo"
  width="250px"
/>

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](https://www.procore.com/)