-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
18b9786
commit 0bcd133
Showing
1 changed file
with
2 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,10 @@ | ||
| # Vite Elm Template | ||
| # Elm Wordle | ||
|
|
||
| [](https://github.com/lindsaykwardell/vite-elm-template/actions/workflows/ci.yml) | ||
| [](https://gitpod.io/#https://github.com/lindsaykwardell/vite-elm-template) | ||
|
|
||
| A default template for building Elm applications using Vite. Includes hot-module reload of Elm modules (courtesy of `vite-plugin-elm`). | ||
|
|
||
| > Vite (French word for "fast", pronounced /vit/) is a build tool that aims to provide a faster and leaner development experience for modern web projects. | ||
| > Elm is a functional language that compiles to JavaScript. It helps you make websites and web apps. It has a strong emphasis on simplicity and quality tooling. | ||
| Live demo site: https://vite-elm-template.netlify.app/ | ||
|
|
||
| ## Features | ||
|
|
||
| - [Hot Module Reload](https://github.com/hmsk/vite-plugin-elm) of all code in the app (including Elm) | ||
| - [Integration with Vite static asset handling](https://package.elm-lang.org/packages/hmsk/elm-vite-plugin-helper/latest/) | ||
| - Tooling installation via [elm-tooling](https://elm-tooling.github.io/elm-tooling-cli/) | ||
| - Includes Elm, elm-format, elm-json, and elm-test-rs | ||
| - Basic unit test and [elm-review](https://package.elm-lang.org/packages/jfmengels/elm-review/latest/) examples | ||
| - Github Actions CI for running tests | ||
| - Recommends the [Elm VS Code extension](https://marketplace.visualstudio.com/items?itemName=Elmtooling.elm-ls-vscode) | ||
|
|
||
| For a single page app (SPA) version of this template, check out [`vite-elm-spa`](https://github.com/lindsaykwardell/vite-elm-spa) | ||
| Basic wordle client in Elm. Hopefully planning to build a bigger game with a wordle base and this is step 1. | ||
|
|
||
| ## Get Started | ||
|
|
||
| ```bash | ||
| # Clone the template locally, removing the template's Git log | ||
| npx tiged lindsaykwardell/vite-elm-template my-elm-app | ||
|
|
||
| # Enter the project, install dependencies, and get started! | ||
| cd my-elm-app | ||
| npm install | ||
| npm run dev | ||
| ``` | ||
|
|
||
| For more information about Vite, check out [Vite's official documentation.](https://vitejs.dev/) | ||
|
|
||
| To learn more about Elm, check out [Elm's official homepage](https://elm-lang.org/). |