README.md

Esbuild Elm Template

A default template for building Elm applications using esbuild and elm-watch
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. Esbuild Elm Template
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

Esbuild Elm Template

A small default template for building Elm applications using esbuild + elm-watch, it is heavily based on elm-watch example. It includes the following features:

• ⚡ Absolute minimalist
• 🔥 Hot reloading on dev mode
• 🛠️ Tooling installation via elm-tooling
• 💅 Elm code linted by elm-review (with reasonable defaults)
• 🧪 Tests are run via elm-test-rs
• 🚀 Production Build (minification using UglifyJS)

The aim of this template is to keep things as simple as possible, so it avoids unwanted bloat.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

Installation

1. Click on the github template button of this repo and clone it, or use tiged:

   npx tiged aotarola/esbuild-elm-template my-elm-app
   cd my-elm-app
   

2. Install NPM packages

   npm ci

(back to top)

Usage

Run the application in developer mode

npm start

Check it out in http://localhost:9000

Build for production

npm run build

(back to top)

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Andres Otarola - @aotarola - [email protected]

Project Link: https://github.com/aotarola/esbuild-elm-template

(back to top)

Acknowledgments

• Got the inspiration from the fabulous vite-elm-template
• Coz elm-watch rocks!
• My mind got blown by esbuild's speed
• And the award for best README goes to Best README

(back to top)