elm-spa/README.md

# [![elm-spa](https://sad-kirch-e164e1.netlify.app/images/logo.png)](https://v6.elm-spa.dev)

# **Installation**

```bash
npm install -g elm-spa@beta
```

## **Learn more**

__Visit the official site__ at [elm-spa.dev](https://v6.elm-spa.dev) for more examples, guides, and other documentation.

## **The Elm package**

__If you are using elm-spa__, there's no read through the [Elm package](https://package.elm-lang.org/packages/ryannhg/elm-spa/latest/) documentation. The package exists to constrain the CLI, and serves as a reference for future contributions.

# **At a glance**

## **1. Create a new project**

```bash
mkdir your-new-app
cd your-new-app
elm-spa new
```

## **2. Check out the new files**

```bash
your-elm-app/
  - elm.json
  - src/Pages/Home_.elm
  - public/index.html
```

## **3. Run it in your browser**

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