npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

samples-viewer-generator

v1.0.0

Published

A CLI utility tool to generate web app of data visualization samples for presentation purpose

Downloads

8

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

rousanrousan

Keywords

chartdatavizcligeneratorboilerplatevisualizationpresentationwebappcliutility

Readme

Build Status NPM version Required Node version NPM total downloads Contributors License

samples-viewer-generator

A CLI utility to generate an web app structure as samples viewer quickly for presentation purpose. It can be used to present your existing data visualization samples in professional way.

An utility tool to generate data viz samples viewer web app quickly.

Demo

Here is the demo.

Requirements

node >= v4.0.0

Note: If node and npm are not installed, Install those from here.

Installation

Install this tool using npm:

$ npm install -g samples-viewer-generator

It installs two binaries: samples-viewer-generator and svgen to your system path.

Usage

At first you need to create a config file in JSON format consisting of sample details, favicon, title for web app etc. as follows:

The config.json file:

{
  "site": {
    "title": "<site title>",
    "heading": "<site heading>",
    "logo": "<site logo> [optional]",
    "favicon": "<site favicon> [optional]",
    "customCSS": "<custom css file to override the existing style> [optional]"
  },
  "samples": [
    {
      "name": "<name of the sample, it should be unique across all samples>",
      "desc": "<a short description of sample>",
      "icon": "<sample icon in .png, .jpeg, or .svg format> [optional]",
      "chart": "<a folder consisting of necessary files (e.g. index.html, js codes) to render the chart on an iframe>",
      "html": "<html code for sample, working code not needed, just for showing purpose> [optional]",
      "js": "<javascript code for sample, working code not needed, just for showing purpose> [optional]",
      "data": "<data for sample> [optional]",
      "notes": "<notes for samples in markdown format, supported github flavoured markdown(gfm)> [optional]"
    }
  ]
}

See example folder for more info.

Then you need to run the cli command svgen (alias of samples-viewer-generator) as follows:

$ svgen -c config.json -o my-samples-viewer

   create : site logo
   create : site favicon
   create : custom CSS
   create : index.html
   create : CSS assets
   create : JavaScript assets
   create : image assets
   create : sample Simple column chart
   create : sample Area 2D chart with gradient
   create : sample Pie chart with legend
   create : sample Zoom line dual Y axis chart
   create : sample Simple World map
   create : site config

Voila! Your samples viewer is generated within seconds.

Note: You should open the generated web app via any local server or remote one. It wouldn't work, if you open through file:// protocol.

Contributing

Your PRs and stars are always welcome.

Checkout the CONTRIBUTING guides.