elm-spa/README.md

# [![elm-spa](https://v6-elm-spa.netlify.app/images/outlined-to-edge.png)](https://elm-spa.dev)

# **Installation**

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

# **Quick start**

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

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

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

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

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

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

# **Learn more**

__Visit the official site__ at [elm-spa.dev](https://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](https://package.elm-lang.org/packages/ryannhg/elm-spa/latest/) package documentation. The package exists to constrain the CLI, and provides basic internal helper functions. Check out the official guide instead!