XUtils

elm-new

Generate initial project scaffolding based on a template.


elm-new

Build Status Build Status

Clojure has lein new, Elixir has mix new and now Elm has elm new!

With elm new you can easily start a new Elm project from the command line.

The idea is to be able to start coding right away instead of wasting time setting up the initial Elm architecture boilerplate. This is especially useful if you do a lot of prototyping.

Features

  • No dependencies — all you need is a shell (like bash, zsh, fish, etc.)
  • Very simple to install and use. Auto-completion included.
  • 100% test covered. It just works!

Simply choose between:

  • sandbox — good for learning about the Elm Architecture
  • element — an Elm application embedded in an HTML element
  • document — an application that has control over the full HTML document
  • application — a single-page app

Example

$ elm-new my-awesome-project

my-awesome-project
├── .gitignore
├── README.md
├── elm.json
└── src
    └── Main.elm

1 directory, 4 files

Your Elm program has been created successfully.
You can use "elm make" to compile it:

    cd my-awesome-project
    elm make src/Main.elm

Run "elm" for more commands.

npm

npm install -g elm-new

yarn

yarn global add elm-new

Chocolatey

choco install elm-new

Homebrew

brew install simonewebdesign/tap/elm-new

Articles

  • coming soon...