Skip to content
master
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Elm Full-Stack

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.

Getting Started

Use this command to run a server and deploy an example app:

elm-fullstack  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-fullstack Executable File

The elm-fullstack executable file contains all the functionality to build apps and operate backend processes. You can download the files from the releases section on Github.

Docker Image

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=secret" 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.

Example Apps

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/master/implement/example-apps/rich-chat-room/readme.md

Elm Editor

The Elm Editor example app is a code editor optimized for the development of Elm apps. It also provides tooling specifically for web frontend-apps to compile and view your app inline.

The Elm Editor frontend builds on the popular Monaco Editor to provide code editing and features like syntax highlighting.

You can’t perform that action at this time.