FaberVitale / vite-elm-ts-template

A vite template to build apps with Elm and typescript

vite-elm-ts-template

Description

A vite template for building apps with elm and typescript.

Features

• Hot Module Replacement thanks to vite and vite-plugin-elm.
• Vite static asset handling provided by vite-plugin-elm.
• Elm tooling installation via elm-tooling.
• CI pipeline.
• Netlify CD.
• Elm linting provided by elm-review.
• Configured Elm unit test environment.
• Automatic Ports and Flags type generation thanks to elm-ts-interop.
• Code linting and formatting on precommit (see config) provided by lintstaged and husky.

Demo

https://vite-elm-ts-template.netlify.app/

Development guide

Quick start

Either open it on your browser (codesandbox) or clone the repository.

Scripts

Install project

npm i

Dev server

npm run dev

Build

npm run build

Generate Ports and Flags types

npm run generate:elm-ts

run tests

npm run test

format

npm run fmt

run linters

npm run lint:elm && npm run lint:ts

Git hooks

On pre-commit, changes are formatted and linted using Husky and lint-staged. See .lintstagedrc.mjs for more details.

CI

• CI workflow

---

License

MIT