Getting Started
Installation
Install the package using your preferred package manager:
# npm
npm i cssvg-icons
# pnpm
pnpm add cssvg-icons
# yarn
yarn add cssvg-icons
# bun
bun add cssvg-icons
Local Development
To run the icon explorer site locally or contribute to the project, clone the repository first.
1. Clone the repository
git clone https://github.com/Harijohnson/cssvg-icon.git
cd cssvg-icon
If you are contributing (adding icons, fixing bugs), fork the repo first on GitHub, then clone your fork:
git clone https://github.com/<your-username>/cssvg-icon.git
cd cssvg-icon
2. Install dependencies
bun install
You can also use
npm install,pnpm install, oryarnif you don't have Bun installed.
3. Start the development server
bun dev
Open http://localhost:3000 to view the site locally.
Contributing
Want to add an icon or improve the project? See the Adding New Icons guide for step-by-step instructions, and the Contributing page for PR rules and checklists.