choonkeat/elm-webapp/1.0.0

NOTE: the latest version is 3.0.2

Formerly choonkeat/create-elm-server, choonkeat/elm-fullstack. Search finds this package by either name.

Elm-Webapp

A setup for writing http based, client-server app in elm, inspired wholly by Lamdera

Getting started

npx elm-webapp element hello-app

This will create a skeleton file directory structure

hello-app
├── Makefile
├── index.js
└── src
    ├── Client.elm
    ├── Server.elm
    ├── Types.elm
    └── Types
        └── Auto.elm

1 directory, 5 files
  • src/Client.elm is where our Browser.element resides. The only exception is, this app includes a built-in sendToServer Task

    To generate Browser.document or Browser.application instead, use either commands

    npx elm-webapp document hello-app
    npx elm-webapp application hello-app
  • src/Server.elm is where our elm Platform.worker resides. It serves your SPA by default, and can respond to sendToServer

  • src/Types.elm includes the custom types that defines the protocol between Client and Server

  • index.js boots up our Server.elm and listens to http requests at port 8000

  • src/Types.elm holds the types shared between Server and Client.

  • src/Types/Auto.elm contains auto-generated Json Encoder and Decoder for all types defined in src/Types.elm. See notes regarding imported types.

License

Copyright © 2021 Chew Choon Keat

Distributed under the MIT license.