Skip to content

Latest commit

 

History

History
executable file
·
36 lines (25 loc) · 1.67 KB

README.md

File metadata and controls

executable file
·
36 lines (25 loc) · 1.67 KB
Raw

Dependency Status devDependency Status

D3 ES6 Project Boilerplate

Boilerplate for D3 projects with Javascript ES6.

Boilerplate Features

  • Automates building and actions using Gulp
  • Manages Browser Javascript using Bower
  • Transpiles ES6+ automagically using Babel and uses sourcemap to better debug code.
  • Local dev server with BrowserSync
  • Compress assets for production with Uglify
  • Lints your code using ESLint (Airbnb code style)
  • Get environment development or production with the JS variable ENV
  • Use Bower to get vendors Javascript libraries and combine them (here D3)

Requirements

  • NodeJs, type npm -v on your terminal to check if you have it.
  • Gulp npm install -g gulp
  • Bower npm install -g bower

Getting Started

  1. Run npm install to install dependencies
  2. Run bower install to download Browser Javacript libraries
  3. Run gulp to start the local dev environment on http://localhost:5000
  4. To have production ready files, run: gulp dist. All built files are located in the folder /build/
  5. Enjoy 🍻

Contributing

If you like this/find it useful/find a bug please open an issue and, better yet, submit a Pull Request!

Any and all help appreciated, thanks!