Giter Club home page Giter Club logo

vis-starter's Introduction

Vis Starter

Start your D3 visualization quick and easy!

Development

Clone into a new directory

git clone [email protected]:vlandham/vis-starter.git my_cool_vis

Install the dependencies:

npm install

Start up the server:

npm start

Start making your visualization! Server should refresh each time you change and save new code.

Deployment

Warning: This has only been tested on Mac OSX.

This repo includes a basic setup for deploying to Github Pages a free hosting solution for static websites.

To try this out, run:

npm run deploy

This should perform the following processes:

  • Build the project
  • Package necessary files into build directory
  • Deploy to Github Pages using the gh-pages package.

The package functionalty currently only includes the following files / directories:

  • index.html
  • bundle.js (created as part of the build process)
  • data/
  • css/

If you need additional files to be deployed, you will need to modify the package script in package.json.

File Organization

The entry-point to the JS code is in index.js. There is some basic data transformation there as well, you might want to change.

A basic chart has been implemented in chart.js. The idea is that you modify this code to make your new chart.

Basic styling is included in css/ including Skeleton CSS.

Data files are meant to go in data/.

Development Packages

  • budo - for the server>
  • browserify - for building.
  • babelify - to use ES6.
  • eslint - for linting.
  • uglify-js - for packaging in deployment.
  • gh-pages - to deploy to gh-pages!
  • prettier - for cleaning up that messy JS.

vis-starter's People

Contributors

vlandham avatar

Stargazers

 avatar Acampbell avatar

Watchers

 avatar James Cloos 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.