1
1
mirror of https://github.com/srid/ema.git synced 2024-11-25 20:12:20 +03:00
Haskell static site generator that is change-aware
Go to file
Sridhar Ratnakumar 613194d359 Allow overriding port using $PORT
Useful as a interim solution to #4
2021-04-21 00:17:56 -04:00
.github/workflows remove unused deps 2021-04-19 11:36:51 -04:00
.vscode initial commit of WIP code 2021-04-19 11:07:52 -04:00
bin Simplify runEma API so race_ is not needed in user programs 2021-04-21 00:05:31 -04:00
src Allow overriding port using $PORT 2021-04-21 00:17:56 -04:00
.ghcid Revert .ghcid to clock example 2021-04-20 15:23:21 -04:00
.gitignore initial commit of WIP code 2021-04-19 11:07:52 -04:00
CHANGELOG.md initial commit of WIP code 2021-04-19 11:07:52 -04:00
default.nix Add default.nix for legacy nix 2021-04-20 18:00:55 -04:00
ema.cabal Expose some modules 2021-04-20 18:14:13 -04:00
ema.svg Add logo 2021-04-20 15:20:12 -04:00
flake.lock Add Diary example using org-mode and fsnotify (#2) 2021-04-20 15:04:48 -04:00
flake.nix Add Diary example using org-mode and fsnotify (#2) 2021-04-20 15:04:48 -04:00
hie.yaml initial commit of WIP code 2021-04-19 11:07:52 -04:00
LICENSE initial commit of WIP code 2021-04-19 11:07:52 -04:00
README.md ... 2021-04-20 17:51:14 -04:00
shell.nix initial commit of WIP code 2021-04-19 11:07:52 -04:00

ema

ema is a WIP next-gen Haskell static site generator that is change-aware. In addition to static site generation, it provides a live server that hot-reload's on code or data change1.

The ultimate goal of ema is to make it possible to easily implement your own neuron, or just about any app that creates a browser view of arbitrarily changing data (on disk, database, or whatever). ema is designed to facilitate creation of apps whose data is normally edited via traditional mechanisms (eg: text editor) but rendered as a delightful web page - so as to provide an economical read-only view, of your data, on desktop & mobile.

The simplest ema app looks like this:

main :: IO ()
main = do
  let name :: Text = "Srid"
  runEmaPure $ \() ->
    encodeUtf8 $ "<b>Hello,</b> " <> name

Hacking

Run bin/run (or Ctrl+Shift+B in VSCode). This runs the clock example; modify ./.ghcid to run a different example.

TODO

  • MVP
  • Implement hot reload, and ditch browser-sync
  • Multi-websocket-client support
  • Refactor Server.hs
  • Static site generation mode
  • add common examples,
    • filesystem watcher
    • docs site for self (w/ sidebar and possibly even search)

pre-announce,

  • plan features / messaging, re: hakyll
    • Safer and simpler routes system
    • Template system?
  • CLI UX (opts, logging, etc.)
  • documentation (howto)
  • Publish Data.LVar to Hackage

doc notes,

  • use async:race to avoid ghcid ghosts
  • at most one ws client supported right now
  • tailwind + blaze-html layout (BlazeWind?) for no-frills getting started

  1. At the moment, only data change triggers a true hot reload; but code change triggers reload via a full page refresh in the browser, which creates a subtle flicker. Ideally this should be improved somehow, possibly by persisting the server and websocket across ghci(d) restarts (cf. ghci-websockets). ↩︎