BookingJini Icons

🚀 Overview

The BookingJini Icons project is a structured repository for converting SVG icons to web fonts using fantasticon, svgo, and oslllo-svg-fixer. This project follows an automated workflow to ensure smooth processing, optimization, and publishing of the icons to npm.

🔗 Visit the official website: icons.bookingjini.com

📌 Icons

For a structured list of all available icons, refer to the Icons Table.

💾 Installation

Ensure you have Node.js 20.13.1 installed.

Note: This version is specifically used as fantasticon is throwing some errors on the updated version. Any fix to this problem is much appreciated.

1️⃣ Clone the Repository

git clone https://github.com/your-repository/bookingjini-icons.git
cd bookingjini-icons

2️⃣ Install Dependencies

npm install

🔧 Usage

You can install and use the icon font in any project:

npm install @bookingjini-labs/bookingjini-icons

Then, in your CSS:

import "@bookingjini-labs/bookingjini-icons/fonts/bookingjini-icons.css";

📦 Use the Icon Library via CDN

You can use the BookingJini Icons library without installing it by including the following CDN link:

<!-- Add this inside your HTML file -->
<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/@bookingjini-labs/bookingjini-icons/dist/fonts/bookingjini-icons.css"
/>

You can use the icons in your HTML like this:

<i class="icon-ac-fill"></i>

📌 Note

🚀 Why We Built This Icon Library

At BookingJini Labs, we needed a scalable and maintainable icon library to streamline our design and development workflow. In the past, we attempted to build an open-source icon library, even listing it in Google Summer of Code (GSoC) to encourage community contributions. However, managing unstructured changes became overwhelming, leading to inconsistencies, and the project was eventually discontinued.

With the need resurfacing, we decided to rebuild the library with automation at its core—eliminating manual steps like SVG optimization and font generation. This time, instead of keeping it internal, we published it as an npm package, making it publicly accessible for others to use, enhance, and contribute, while ensuring it remains structured and maintainable. 🚀

🚨 The Challenges with the Old Workflow

In the previous version, the process of maintaining icons involved several manual steps:

1️⃣ Designers provided SVGs.
2️⃣ We manually converted them into web fonts using IcoMoon.
3️⃣ The generated CSS was manually uploaded to a CDN (e.g., jsdelivr).
4️⃣ Every icon update required repeating this tedious process.

This approach was inefficient, time-consuming, and prone to errors.

🚀 How We Automated Everything

To eliminate manual intervention, we completely revamped the workflow:

✅ Automated font generation using fantasticon. (Due to compatibility issues, we use fantasticon@1.2.3, which works seamlessly with Node.js 20.13.1.)
✅ Automated SVG optimization using oslllo-svg-fixer and svgo to fix and compress icons.
✅ Fully integrated build process that handles everything from SVG processing to publishing the package on npm.

We are continuously improving this package to make it more efficient, scalable, and developer-friendly. Your feedback, contributions, and suggestions are always welcome! 🚀

📂 Project Setup

📁 Folder Structure

bookingjini-icons/
├── font-dist/      # 🎨 Contains the final generated font files
├── icons-dist/     # 🛠 Contains the fixed and optimized SVG icons
├── icons-source/   # 📝 Contains the raw SVG icons before processing
├── .github/        # 🔄 Contains the GitHub Actions workflow for publishing
├── .gitignore      # ❌ Ignores node_modules and other unnecessary files
├── package.json    # 📜 Contains the project configuration and scripts
├── svgo.config.js  # ⚙️ Configuration for SVG optimization
└── README.md       # 📖 Documentation

🛠 Tools Used

To process and convert SVG icons into a web font, we use the following npm tools:

npm install -g fantasticon@1.2.3  # 📌 Specific version to avoid punycode error
npm i -D svgo                     # 🎨 Optimizes SVG files
npm install oslllo-svg-fixer       # 🛠 Fixes SVG formatting issues

📜 Project Configuration

package.json

The package.json file defines project metadata and scripts. Below is a breakdown of the scripts section:

{
  "name": "@bookingjini-labs/bookingjini-icons",
  "description": "A custom icon font library for BookingJini",
  "version": "1.0.0",
  "main": "dist/fonts/bookingjini-icons.css",
  "exports": {
    "./bookingjini-icons.css": "./dist/fonts/bookingjini-icons.css"
  },
  "files": ["dist/fonts/"],
  "publishConfig": {
    "access": "public"
  },
  "license": "MIT",
  "scripts": {
    "build": "npm run icons:fix && npm run icons:compress && npm run icons:font",
    "icons:fix": "node node_modules/oslllo-svg-fixer/src/cli.js -s=src/svg -d=dist/svg",
    "icons:compress": "svgo dist/svg -o dist/svg --config=svgo.config.js",
    "icons:font": "fantasticon"
  },
  "dependencies": {
    "oslllo-svg-fixer": "^5.0.0"
  },
  "devDependencies": {
    "fantasticon": "^1.2.3",
    "svgo": "^3.3.2"
  },
  "keywords": [],
  "repository": {
    "type": "git",
    "url": "git+https://github.com/ramanujamgond/bookingjini-icons.git"
  }
}

📝 Explanation of Scripts:

• build: 🏗 Runs the complete build process by executing icons:fix, icons:compress, and icons:font sequentially.
• icons:fix: 🔧 Uses oslllo-svg-fixer to clean and standardize raw SVGs from icons-source/ and save them in icons-dist/.
• icons:compress: 🎨 Uses svgo to optimize the cleaned SVG files in icons-dist/ and outputs them into font-dist/ using svgo.config.js.
• icons:font: 🏗 Uses fantasticon to convert optimized SVG files into web font files stored in font-dist/.
• test: 🛠 Placeholder test script that currently outputs an error.

⚙️ SVGO Configuration (svgo.config.js)

This configuration optimizes SVG files by removing unnecessary metadata and formatting.

module.exports = {
  multipass: true, // 🔄 Runs multiple passes to optimize SVG further
  plugins: [
    { name: "removeViewBox", active: false }, // 🖼 Keeps the viewBox attribute (important for scaling)
    { name: "removeDimensions", active: true }, // 📏 Removes width/height attributes to make the SVG responsive
    { name: "convertColors", params: { currentColor: true } }, // 🎨 Converts colors to `currentColor` for theme-based coloring
    { name: "cleanupNumericValues", params: { floatPrecision: 2 } }, // 🔢 Reduces the number of decimal places in numeric values
  ],
};

🚀 Workflow & Publishing

This repository includes an automated workflow inside .github/workflows/ that handles:

• 🛠 Processing & optimizing SVG icons
• 🎨 Generating web fonts using fantasticon
• 📦 Publishing to npm

🛠 Troubleshooting

• ❌ If punycode errors occur, ensure you are using fantasticon@1.2.3.
• ❌ Ensure icons-source/ contains valid SVG files before running npm run build.
• ❌ If publishing issues occur, check GitHub Actions logs in .github/workflows/.

📚 Useful Resources

• Create an Icon Web Font for Your Design System
• Setting Up SVG Fixer (oslllo-svg-fixer) in Frontend Project
• Fantasticon Documentation
• SVG to Font Icons Using NodeJS (YouTube)
• Solving the Punycode Module Deprecation Issue in Node.js

👥 Contributors

• Ramanujam Gond

📜 License

MIT License