2021-02-22 00:51:09 +03:00
# [](https://elm-spa.dev)
2020-03-28 09:46:45 +03:00
2021-01-16 06:39:37 +03:00
# **Installation**
2020-03-30 04:51:10 +03:00
2021-01-16 06:39:37 +03:00
```bash
2021-02-12 07:11:15 +03:00
npm install -g elm-spa@latest
2020-03-30 04:51:10 +03:00
```
2021-02-04 06:49:31 +03:00
# **Quick start**
2021-01-16 06:51:12 +03:00
## **1. Create a new project**
```bash
2021-02-04 06:49:31 +03:00
mkdir your-new-project
cd your-new-project
2021-01-16 06:51:12 +03:00
elm-spa new
```
## **2. Check out the new files**
```bash
2021-02-04 06:49:31 +03:00
your-new-project/
2021-01-16 06:51:12 +03:00
- elm.json
- src/Pages/Home_.elm
- public/index.html
```
## **3. Run it in your browser**
```bash
elm-spa server # Ready at http://localhost:1234
```
2021-02-04 06:48:55 +03:00
# **Learn more**
2021-02-12 07:11:15 +03:00
__Visit the official site__ at [elm-spa.dev ](https://elm-spa.dev ) for more examples, guides, and other documentation.
2021-02-04 06:48:55 +03:00
## **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!
