Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simonh1000/elm-webpack-starter
Elm 0.19.1, Webpack 5 & Tailwind
https://github.com/simonh1000/elm-webpack-starter
developer-tools elm hot-reload webpack-dev-server webpack5
Last synced: 20 days ago
JSON representation
Elm 0.19.1, Webpack 5 & Tailwind
- Host: GitHub
- URL: https://github.com/simonh1000/elm-webpack-starter
- Owner: simonh1000
- License: mit
- Created: 2017-02-13T19:59:35.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-10T09:35:14.000Z (9 months ago)
- Last Synced: 2024-11-14T00:05:55.970Z (29 days ago)
- Topics: developer-tools, elm, hot-reload, webpack-dev-server, webpack5
- Language: JavaScript
- Homepage:
- Size: 1.18 MB
- Stars: 343
- Watchers: 11
- Forks: 39
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - simonh1000/elm-webpack-starter - Elm 0.19.1, Webpack 5 & Tailwind (JavaScript)
README
# Elm 0.19.1 with Webpack 5, Hot Reloading & Tailwind
[](https://circleci.com/gh/simonh1000/elm-webpack-starter)
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
```sh
$ git clone [email protected]:simonh1000/elm-webpack-starter.git new-project
$ cd new-project
$ npm install
```
**Notes**
- This starter is formatted with [elm-format globally](https://github.com/avh4/elm-format#installation-), which you will also want to install.
## Developing
Start with Elm debug tool with either
```sh
$ npm start
or
$ npm start --nodebug
```
the `--nodebug` removes the Elm debug tool. This can become valuable when your model becomes very large.
Open http://localhost:3000 and start modifying the code in /src. **Note** that this starter expects you have installed [elm-format globally](https://github.com/avh4/elm-format#installation-).
## Production
Build production assets (js and css together) with:
```sh
npm run prod
```
## Static assets
Just add to `src/assets/` and the production build copies them to `/dist`
## Testing
[Install elm-test globally](https://github.com/elm-community/elm-test#running-tests-locally)
`elm-test init` is run when you install your dependencies. After that all you need to do to run the tests is
```
npm test
```
Take a look at the examples in `tests/`
If you add dependencies to your main app, then run `elm-test --add-dependencies`
## Elm-analyse
Elm-analyse is a "tool that allows you to analyse your Elm code, identify deficiencies and apply best practices." Its built into this starter, just run the following to see how your code is getting on:
```sh
$ npm run analyse
```
## Circle CI
```sh
$ circleci local execute --job build
```
## ES6
This starter includes [Babel](https://babeljs.io/) so you can directly use ES6 code.
## Changelog
- 4.0.0 - Webpack 5, adds Tailwind support out of the box
- 3.10.4 - Use better webpack defaults in dev mode
- 3.10.0 - Css minify
- 3.9.3 - Update deps
- 3.9.2 - Update elm/core and other deps
- 3.9.1 - Version 0.19.1
- 3.9.0 - Switch the closure compiler for minification in prod
- 3.8.0 - Update deps
- 3.7.0 - Add elm-analyse
- 3.6.0 - Add CI script
- 3.5.0 - Simpler means to work with/out the debug window
- 3.4.0 - Add ability to start dev mode without debug window
- 3.3.0 - Switch to elm/http 2.0.0 (and other deps updates)
- 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
## How it works
`npm run dev` maps to `webpack-dev-server --hot --colors --port 3000` where
- `--hot` Enable webpack's Hot Module Replacement feature
- `--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.
- `--colors` should show the colours created in the original Elm errors, but does not (To Fix)
One alternative is to run `npx webpack-dev-server --hot --colors --host=0.0.0.0 --port 3000` which will enable your dev server to be reached from other computers on your local network
## Credits
A long time ago this code was forked from https://github.com/fluxxu/elm-hot-loader