Giter Club home page Giter Club logo

iconic's Introduction

MIT license Maintenance Npm package version Minimum node.js version

Iconic - Simplify your Icon usage during development!

This package provides a web ui for visualizing your icons and making them easier to find.

Basic usage npx @japudcret/iconic --icon-path src/icons/

CLI

$ npx japudcret-iconic -h

Usage: npx japudcret-iconic --icon-path <path-to-icons> [-v] [-p port] [-r regex] [-h]


Options:
      --version    Show version number                                 [boolean]
  -v, --verbose    Debug Mode                         [boolean] [default: false]
  -p, --port       Port                                 [number] [default: 5000]
  -i, --icon-path  Icon Path (e.g. src/icons/)                        [required]
  -r, --regex      Regular Expression to find the icon files
                  [default: "([^.]+).(apng|avif|gif|jpg|jpeg|ico|svg|png|webp)"]
  -h, --help       Show help                                           [boolean]

Development

Local testing

You can locally test the functionality by starting the backend and the frontend separately.

Start the backend (express dev server)

Start a local server that will mimic the environment created by npx

npm run start-express

This server uses only static source files found under build/ and assumes you have icons under test/.

Start the frontend (React dev server)

npm run start-react

Test the package

Compile with

npm run build

Create a package

npm pack

Publish the package to your local (global) repository

npm install -g japudcret-iconic-0.2.0.tgz

Afterwards you can use npx iconic to test your latest version.

iconic's People

Contributors

japudcret avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.