nazerbayev / elm-webpack-starter

Elm 0.19 + Webpack 4 with hot-reloading! (Includes Babel 7 for your JS)

Elm 0.19 with Webpack 4, Hot Reloading & Babel 7

Elm dev environment with hot-loading (i.e. state is retained as you edit your code - Hot Module Reloading, HMR)). I use this daily for my professional work. Like elm-community/elm-webpack-starter but using Webpack 4.

Installation

Clone this repo into a new project folder and run install script. (You will probably want to delete the .git/ directory and start version control afresh.)

With npm

$ git clone [email protected]:simonh1000/elm-webpack-starter.git new-project
$ cd new-project
$ npm install
$ npm run dev

With yarn

$ git clone [email protected]:simonh1000/elm-webpack-starter.git new-project
$ cd new-project
$ yarn
$ yarn dev

Open http://localhost:3000 and start modifying the code in /src. (An example using Routing is provided in the navigation branch)

Production

Build production assets (js and css together) with:

npm run prod

Static assets

Just add to src/assets/ and the production build copies them to /dist

Testing

Install elm-test globally

elm-test init is run when you install your dependencies. After that all you need to do to run the tests is

yarn test

Take a look at the examples in tests/

If you add dependencies to your main app, then run elm-test --add-dependencies

---

ES6

This starter includes Babel so you can directly use ES6 code.

Changelog

• 3.2.0 - Add elm-minify to prod builds (thanks Asger)
• 3.1.0 - Revert to webpack-dev-server with example
• 3.0.2 - bugfixes (mostly for tests)
• 3.0.1 - use publicPath to ensure compatibility with more complex routes
• 3.0.0 - version 0.19
• 2.1.0 - switch to webpack-serve (from webpack dev server)
• 2.0.0
  • Remove Bootstrap (use purecss as simple alternative - you don't want me choosing your css framework after all)
  • Compile CSS into separate file
• 1.2.0 - Webpack 4, Babel 7
• 1.1.0 - add elm-verify-examples

Credits

A long time ago this code was forked from https://github.com/fluxxu/elm-hot-loader

How it works

webpack-serve --hot --colors --port 3000
webpack-serve --hot --host=0.0.0.0 --port 3000

• --hot Enable webpack's Hot Module Replacement feature
• --host=0.0.0.0 - enable you to reach your dev environment from another device - e.g your phone
• --port 3000 - use port 3000 instead of default 8000
• inline (default) a script will be inserted in your bundle to take care of reloading, and build messages will appear in the browser console.