mirror of
https://github.com/ryannhg/elm-spa.git
synced 2024-11-25 06:22:52 +03:00
41 lines
951 B
Markdown
41 lines
951 B
Markdown
# [](https://elm-spa.dev)
|
|
|
|
# **Installation**
|
|
|
|
```bash
|
|
npm install -g elm-spa@latest
|
|
```
|
|
|
|
# **Quick start**
|
|
|
|
## **1. Create a new project**
|
|
|
|
```bash
|
|
npx 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
|
|
npx 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 the [ryannhg/elm-spa](https://package.elm-lang.org/packages/ryannhg/elm-spa/latest/) package documentation. The package only exists to constrain the CLI, and provides a few basic internal helper functions.
|
|
|
|
Check out [the official website](https://elm-spa.dev) instead!
|