FormidableLabs/electron-webpack-dashboard

Name: electron-webpack-dashboard

Owner: Formidable

Description: Electron Desktop GUI for Webpack Dashboard

Created: 2017-08-16 16:12:36.0

Updated: 2018-01-18 11:16:56.0

Pushed: 2018-01-17 19:09:34.0

Homepage: http://formidable.com/blog/2017/introducing-electron-webpack-dashboard/

Size: 2271

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

electron-webpack-dashboard

Electron Desktop GUI for Webpack Dashboard


http://i.imgur.com/9TObNrN.png

Whats this all about?

The original webpack-dashboard, was fun and people seemed to like it. Unless they were on Windows, or used a weird terminal set up, or if they just wanted more.

Making things work across a variety of different terminal environments is pretty rough. Also, a web GUI provides some unique UI possibilities that weren't there with the term display.

So here we are.

The original dashboard felt like working at NASA. 50 years ago. I hope this dashboard feels like working at NASA today. Or at Westworld. Or like the beginning of Westworld at least.

Getting Started
Install

Download the version for your OS here:

https://github.com/FormidableLabs/electron-webpack-dashboard/releases/latest

If you are on macOS you can also install the app via Homebrew Cask:

ew update
ew cask install webpack-dashboard
Webpack 3 compatibility

To receive a complete analysis of your bundle, including modules, assets, and problems, you will need to make sure your project is using Webpack Dashboard Plugin 1.0 or higher.

Configuring Your Project

First, in your project, install the webpack-dashboard plugin:

npm install webpack-dashboard --save-dev

Next, in any Webpack config you want telemetry on, import the plugin:

t DashboardPlugin = require('webpack-dashboard/plugin');

Then add the plugin to your config's plugins array, like so:

ins: [
 ... your other plugins
new DashboardPlugin()

Usage

Simply hit save on a project running webpack-dev-server, or run your build task that builds with webpack and providing you have configured your project as shown above, you should see the dashboard start to display data.

Credits

The visualizations view was essentially recreated using code from https://github.com/chrisbateman/webpack-visualizer, and I am forever grateful that I didn't have to figure this stuff out on my own.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.