Installation

npm install -g elm-spa@latest

Quick start

1. Create a new project

mkdir your-new-project
cd your-new-project
elm-spa new

2. Check out the new files

your-new-project/
  - elm.json
  - src/Pages/Home_.elm
  - public/index.html

3. Run it in your browser

elm-spa server   # Ready at http://localhost:1234

Learn more

Visit the official site at elm-spa.dev for more examples, guides, and other documentation.

Do I need the Elm package?

If you are using elm-spa, there's no need to read through the ryannhg/elm-spa package documentation. The package exists to constrain the CLI, and provides basic internal helper functions. Check out the official guide instead!