All Projects β†’ rousan β†’ Samples Viewer Generator

rousan / Samples Viewer Generator

Licence: mit
πŸŽ‰ A CLI utility tool to generate web app of data visualization samples for presentation purpose

Projects that are alternatives of or similar to Samples Viewer Generator

Ignite
Infinite Red's cutting edge React Native project boilerplate, along with a CLI, component/model generators, and more!
Stars: ✭ 13,296 (+102176.92%)
Mutual labels:  cli, boilerplate, generator
Pollinate
Template your base files and generate new projects from Git(Hub).
Stars: ✭ 213 (+1538.46%)
Mutual labels:  cli, boilerplate, generator
Extension Create
Create modern cross-browser extensions with no build configuration.
Stars: ✭ 167 (+1184.62%)
Mutual labels:  cli, boilerplate, generator
Bogus
πŸ“‡ A simple and sane fake data generator for C#, F#, and VB.NET. Based on and ported from the famed faker.js.
Stars: ✭ 5,083 (+39000%)
Mutual labels:  data, generator
Plop
Consistency Made Simple
Stars: ✭ 4,765 (+36553.85%)
Mutual labels:  cli, generator
Create Graphql
Command-line utility to build production-ready servers withΒ GraphQL.
Stars: ✭ 441 (+3292.31%)
Mutual labels:  cli, boilerplate
J
❌ Multi-format spreadsheet CLI (now merged in http://github.com/sheetjs/js-xlsx )
Stars: ✭ 343 (+2538.46%)
Mutual labels:  cli, data
Devkit
Stars: ✭ 561 (+4215.38%)
Mutual labels:  cli, generator
Ttyplot
a realtime plotting utility for terminal/console with data input from stdin
Stars: ✭ 532 (+3992.31%)
Mutual labels:  cli, chart
Wunderbar
Simple horizontal bar chart printer for your terminal
Stars: ✭ 572 (+4300%)
Mutual labels:  cli, chart
Faker
Faker is a pure Elixir library for generating fake data.
Stars: ✭ 673 (+5076.92%)
Mutual labels:  data, generator
Swaggen
OpenAPI/Swagger 3.0 Parser and Swift code generator
Stars: ✭ 385 (+2861.54%)
Mutual labels:  cli, generator
Superplate
Performance-oriented frontend application creator with popular tools.
Stars: ✭ 368 (+2730.77%)
Mutual labels:  cli, boilerplate
Xcodegen
A Swift command line tool for generating your Xcode project
Stars: ✭ 5,032 (+38607.69%)
Mutual labels:  cli, generator
Hygen
The simple, fast, and scalable code generator that lives in your project.
Stars: ✭ 4,107 (+31492.31%)
Mutual labels:  cli, generator
Vim Doge
(Do)cumentation (Ge)nerator 10+ languages πŸ“š Generate proper code documentation skeletons with a single keypress. ⚑️πŸ”₯
Stars: ✭ 533 (+4000%)
Mutual labels:  boilerplate, generator
Ignite Bowser
Bowser is now re-integrated into Ignite CLI! Head to https://github.com/infinitered/ignite to check it out.
Stars: ✭ 586 (+4407.69%)
Mutual labels:  cli, boilerplate
Reactprimer
React component prototyping tool that generates fully connected class component code.
Stars: ✭ 743 (+5615.38%)
Mutual labels:  boilerplate, generator
Agots
Anomaly Generator on Time Series
Stars: ✭ 24 (+84.62%)
Mutual labels:  data, generator
Graphback
Graphback - Out of the box GraphQL server and client
Stars: ✭ 323 (+2384.62%)
Mutual labels:  cli, generator

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.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].