https://github.com/sporto/elm-patterns
A collection of common patterns for Elm
https://github.com/sporto/elm-patterns
Last synced: 3 months ago
JSON representation
A collection of common patterns for Elm
- Host: GitHub
- URL: https://github.com/sporto/elm-patterns
- Owner: sporto
- Created: 2016-04-24T23:02:23.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-26T06:13:40.000Z (9 months ago)
- Last Synced: 2025-03-29T04:06:17.212Z (3 months ago)
- Language: Elm
- Homepage: http://sporto.github.io/elm-patterns/
- Size: 1.97 MB
- Stars: 124
- Watchers: 9
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Elm Patterns
A collection of common patterns in Elm .
## Development
### mdbook
This book uses mdbook:
To view locally run
```
mdbook serve -p 5000
```
Deployment is done automatically via github actions (No need to build the book).
## Contributing
This guide documents patterns that are commonly used in Elm applications.
- Avoid uncommon or esoteric patterns.
- The pattern explanation needs to be as simple as possible. Don't write a whole essay for each one. They should be easy to read and understand in a few minutes (whenever possible).
- Avoid complex terminology e.g. Monads, Applicative, etc. Unless this is really critical for understanding the pattern.
- The pattern explanation doesn't need to be thorough (i.e. show all the code). As long at it conveys the idea and benefits. Linking to a more detailed source is great.
- These patterns should try to align with the community recommendations and best practices.
- Write in first person voice using the pronoun "we". E.g. "We might choose to use X".