npm package: @ncollin/icons-library
Description: Nurun Icons Library extracted from Figma
Latest version: 1.26.1

<a name="readme-top"></a>

<br />
<div align="center">
  <a href="https://bitbucket.org/nuruncode">
    <img src=".readme/images/nurun-logo.svg" alt="Nurun">
  </a>

  <h3 align="center">Nurun Icons Library</h3>

  <p align="center">
    A collection of svg icons for Nurun projects
    <br />
    <a href="https://bitbucket.org/nuruncode/nurun-component-library/src/develop/packages/ncl-icons"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://bitbucket.org/nuruncode/nurun-component-library/issues">Report a Bugs</a>
    ·
    <a href="https://bitbucket.org/nuruncode/nurun-component-library/issues">Request Feature</a>
  </p>
</div>

## Table of Contents

<ol>
  <li>
    <a href="#about-the-project">About The Project</a>
    <ul>
      <li><a href="#built-with">Built With</a></li>
    </ul>
  </li>
  <li>
    <a href="#getting-started">Getting Started</a>
    <ul>
      <li><a href="#prerequisites">Prerequisites</a></li>
      <li><a href="#installation">Installation</a></li>
    </ul>
  </li>
  <li><a href="#usage">Usage</a></li>
  <li><a href="#roadmap">Roadmap</a></li>
  <li><a href="#contributing">Contributing</a></li>
  <li><a href="#contact">Contact</a></li>
</ol>

## About The Project

The goal of the **ncl-icon** project is to centralize all SVG icons from all Nurun projects. In the philosophy of bringing Design to Code, we are extracting the SVG files directly from Figma, we are creating a NPM package to make them accessible for any developers to use in their project.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

### Built With

The following technology are used to build this project:

- [NodeJs](https://nodejs.org/en)
- [Types(cript](https://www.typescriptlang.org/)
- [Jest](https://jestjs.io/)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- GETTING STARTED -->

## Getting Started

### Prerequisites

Make sure to have the latest version of node installed.

- npm
  ```sh
  npm install npm@latest -g
  ```

### Installation

This project is part of a monorepo.

1. Clone the repo
   ```sh
   git clone git@bitbucket.org:nuruncode/nurun-component-library.git
   ```
2. Install NPM packages
   ```sh
   npm install
   ```

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- USAGE EXAMPLES -->

## Usage

Here is the flow to add or update a new icon collection.

1. In /src, create a folder for your project.
2. Copy all svg files in that new project folder.
3. Run the build script from the package.json
   ```sh
   npm run build
   ```

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- ROADMAP -->

## Roadmap

- [ ] Extract svg from Figma

See the [open issues](https://bitbucket.org/nuruncode/nurun-component-library/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/name-of-the-feature`)
3. Commit your Changes (`git commit -m 'Add some name-of-the-feature'`)
4. Push to the Branch (`git push origin feature/name-of-the-feature`)
5. Open a Pull Request

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- CONTACT -->

## Contact

Nico Collin - nico.collin@nurun.com<br/>
Etienne Dion - etienne.dion@nurun.com

Project Link: [ncl-icons](https://bitbucket.org/nuruncode/nurun-component-library/src/develop/packages/ncl-font-icons/)

<p align="right">(<a href="#readme-top">back to top</a>)</p>