Elm Vite Template
Elm Vite Template
Minimalistic Elm Template powered by Vite!
View Demo »
Explore the docs
·
Report Bug
·
Request Feature
Table of Contents
About The Project
A simple and intuitive Elm template powered by Vite. Built in TailwindCSS and HMR. Focus on the application itself rather than all these low-level configuration stuffs.
Incentives:
- Could not find intuitive Elm starter templates
- The Elm development workflow is awkward
- Want to try out Elmish architecture
- Buitl this Elm template so I can use for other projects.
Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!
Built With
The technologies and tools used within this template.
- Elm
- Vite
- TailwindCSS
- JavaScript
Getting Started
Prerequisites
The list of tools that is used when development.
Installation
To use this template for personal use or contribution, simply perform the following.
- Clone the repo
git clone https://github.com/data-miner00/elm-vite-template.git - Install Node dependencies
pnpm i - Optionally update the dependencies
pnpm up --latest - Recommend to run tests to check if things are breaking
pnpm test - Run formatter to format code
pnpm format - Review Elm code quality
pnpm review - Start dev server
pnpm dev - Compile for production
pnpm build - Preview production build
pnpm preview - Start standalone Elm reactor
pnpm elm:dev - Build standalone Elm code
pnpm elm:build - Start interactive Elm shell
pnpm repl
Roadmap
- Add Homepage
- Add 404 page
- Dark mode
- Add GitHub workflows
- Add PWA Manifest
- Mobile Responsive
- Navbar and header
- Add E2E tests
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the Apache 2.0 License. See LICENSE for more information.
Acknowledgments
List of resources that are helpful and would like to give credit to.
