Skip to content

Command Line Utility for creating an Elm boilerplate project easy to run, build and get deployed

License

Notifications You must be signed in to change notification settings

GioPat/elm-boil

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

74 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Elm Boil

NPM version node version Build Status

Handle Elm Project with almost zero effort 🍲.

Quickstart

Node >= 12.10.0

  npm install -g elm-boil
  elm-boil init my-elm-app
  cd ./my-elm-app
  npm start

Create a production build with npm run build -- --output my-elm-build

Note that you can modify your package.json and pass your custom parameters to the elm-boil utility.

Getting Started

Installation

Make sure you have Node >= 12.10.0 installed

npm install -g elm-boil

Create project

This command scaffolds a new Elm project with the support of scss compilation and Elm environment variable handling as it's described in this answer provided by the creator of elm-spa-example.

Usage:

elm-boil init <project_name>

Project structure:

my-elm-app
├── README.md
├── package.json
├── elm.json
├── .gitignore
├── assets
│   ├── favicon.ico
│   └── elm-logo.svg
├── env                 - Env variables (not versioned)
├── env-default         - Default Env (versioned)
├── public
|   └── index.html      - index.html template
└── src
    ├── Main.elm
    └── Main.scss

Serve Project

This command starts a local webserver helping development phase of the application using live elm and scss compilation plus a livereload functionality.

Usage (inside the project directory):

elm-boil serve [-p|--port=3000] [-h|--host="0.0.0.0"]

Build Project

This command creates a minified and uglified build inside the project directory. A content hash is added to the file name allowing you to use aggressive caching techniques.

Usage (inside the project directory):

elm-boil build [-o|--output=dist]

A good idea to use the output parameter could be a parallel centered distribution of the same frontend for multiple environments.

Why do I chose elm-boil?

  • Single dependency
  • Support of SCSS
  • Lightweight
  • Extremely fast
  • Ease of use

Contributing

Feel free to submit issues and enhancement requests 🚀🚀!.

Popular alternatives

About

Command Line Utility for creating an Elm boilerplate project easy to run, build and get deployed

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •