@goodrequest/web-icons

Web SVG icon library

This library provides a collection of web SVG icons that can be easily used in react web projects.

Installation

You can install the library via npm:

npm install @goodrequest/web-icons

Usage

To use the icons in your project, you can import them into your TypeScript files as follows:

import { IconName } from '@goodrequest/web-icons';

Development

To set up the development environment and build the library:

Clone this repository:

git clone [e-mail]:GoodRequest/Web-Icons.git

Install dependencies:

npm install

Build library:

To build the library:

npm run build

How to add a new icon?

Follow this steps

First step

add new icons to related folders in folder assets/icons

Second step

run this command

npm run svgr

then try run build

Final step

Push changes and increase the patch version

npm version patch

[!WARNING] Attention, if you're adding a new folder for a new category of icons (such as generals, arrows, media, etc...), don't forget to add an export of this folder to the src/index.ts file.

The compiled library will be available in the lib directory.

License

This project is licensed under the MIT License.