{"repo":"iconify/api","free":true,"listed":false,"github":"https://github.com/iconify/api","clone":"git clone https://github.com/iconify/api.git","description":"Iconify API script. Search engine for icons, provides icon data on demand for icon components, dynamically generates SVG.","language":"TypeScript","stars":181,"topics":["api","icons","svg"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"Iconify API This repository contains Iconify API script. It is a HTTP server, written in Node.js that: - Provides icon data, used by icon components that load icon data on demand (instead of bundling thousands of icons). - Generates SVG, which you can link to in HTML or stylesheet. - Provides search engine for hosted icons, which can be used by icon pickers. NPM Package This package is also available at NPM, allowing using API code in custom wrappers. NPM package contains only compiled files, to build custom Docker image you need to use source files from Git repository, not NPM package. Docker To build a Docker image, run ./docker.sh . If you want to customise config, fork this repo, customise source code, then build Docker image and deploy API. To run a Docker image, run docker run -d -p 3000:3000 iconify/api (change first 3000 to port you want to run API on). NPM commands for working with Docker images: - npm run docker:build - builds Docker image. - npm run docker:start - starts Docker container on port 3000. - npm run docker:stop - stops all Iconify API Docker containers. - npm run docker:cleanup - removes all unused Iconify API Docker containers. There is no command to remove unused images because of Docker limitations. You need to do it manually from Docker Desktop or command line. How to use it First, you need to install NPM dependencies and run build script: Then you can start server: By default, server will: - Automatically load latest icons from @iconify/json . - Lo","default_branch":null,"files":null,"tree":[],"storefront":"/r/iconify","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/iconify/api/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}