Elm Fullstack simplifies building full-stack web apps using the Elm programming language.
The framework supports:
- Building a web-server around a backend app modeled using the Elm programming language.
- Sharing Elm modules with common functions and types between frontend and backend implementations.
- Using the Elm Architecture on the backend by providing automatic persistence, replication, and migrations.
- Automating the generation of functions to serialize and deserialize Elm values.
Use this command to run a server and deploy an example app:
elm-fs run-server --public-urls="http://*:5000" --deploy-app-from=https://github.com/elm-fullstack/elm-fullstack/tree/557b615e028682f1b45121fe73bf7b4455a6f13b/implement/example-apps/docker-image-default-app
For a guide on configuration options, structuring your Elm app code, deploying, migrating, etc., see How to Configure and Deploy an Elm-Fullstack App.
Releases / Artifacts
elm-fs Executable File
elm-fs executable file contains all the functionality to build apps and operate backend processes. You can download the files from the releases section on Github.
If you prefer deploying using docker, use the
elmfullstack/elm-fullstack image from docker hub. The tags are aligned with the version IDs in the CLI executable file.
docker run -p 5000:80 -p 4000:4000 --env "APPSETTING_adminPassword=test" elmfullstack/elm-fullstack
To learn more about these artifacts' interfaces, see How to Configure and Deploy an Elm-Fullstack App.
Building from Source
The easiest way to test a change in the source code is to trigger the Github action workflow in
.github/workflows/test-and-publish.yml. This workflow gets you the results of automated tests and your version of the executable files. Push to your fork on Github to trigger this action.
As we can see in the workflow file, the project uses .NET core 3.1 to run tests and build the executable file. You can download the
dotnet tool from https://dotnet.microsoft.com/download/dotnet-core to build and test locally.
Rich Chat Room
The rich chat room example app demonstrates features typically found in a chat app, such as user names, message rate-limiting, sound effects, etc. For a detailed description of this app, see the readme file at https://github.com/elm-fullstack/elm-fullstack/blob/main/implement/example-apps/rich-chat-room/readme.md
Elm Editor is an editor for developing Elm programs. It also provides tooling specifically for web frontend-apps to compile and view an app inline.
To see Elm Editor in action, check out the public instance at https://elm-editor.com
To learn more about how it works, see https://github.com/elm-fullstack/elm-fullstack/tree/main/implement/example-apps/elm-editor/readme.md