Skip to content

matheusAle/iconns-ws

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

iconns-ws

It is a simple webservice for plugin Iconns of Adobe XD.

Where the Icons Come From

Currently, the webservice research only in IconFinder Plataform. Only free icons is researched and returner.

About the optmize SVG

The dependencie SVGO is used for optimize the file and convert all nodes in paths. This is requered becouse the Adobe XD not suport imports of SVG file in artboard through plugins.

Endpoints

Search [/search?q=icon+name]

The response is a json array of objects

{
  "download_url": "/* url for download the icon optimized in SVG format. */",
  "preview_url": "/* url for request a preview file for this icon. */"
}

Downlaod [/<download_url>]

For dowload a icon you should be meke a request for this webservice host with the value in download_url. The response is a text body with svg file content.

Known Issues

  • For complex ions the result cannot be exactly the expected.

How to Start

The master branch webservice is deployed on Heroku Plataform in a free Dino. You can use: https://iconns-ws.herokuapp.com/

Run local

You need pass the envs var: ICON_FINDER_CLIENT_ID and ICON_FINDER_CLIENT_SECRET. For consume the Iconfinder api.

To start

  • npm start: run with directally in node engine
  • npm start:dev: run with global instalation of nodemon
  • npm test: run the mocha tests with --watch flag

Releases

No releases published

Packages

No packages published