Giter Site home page Giter Site logo

jphedley / example-servant-elm Goto Github PK

View Code? Open in Web Editor NEW

This project forked from haskell-servant/example-servant-elm

0.0 2.0 0.0 25 KB

Example for a web app with a servant backend and an elm frontend

Makefile 7.79% Haskell 54.55% Elm 37.66%

example-servant-elm's Introduction

Haskell Servant and Elm Example

This example project illustrates how to set up a project that:

  • Uses haskell and servant as a backend exposing a JSON api (and serving some files).
  • Uses elm to write the frontend.
  • Uses servant-elm to generate client functions in elm for the JSON api. This means that mismatches regarding the JSON api will be detected statically.
  • Allows a very fast development cycle: You can type-check the server and client code in a very short amount of time.

Makefile

There's a Makefile included with the following targets:

  • setup -- Set up everything: install ghc and dependencies. (Needs stack, elm and elm-test.)
  • build -- Build the server and the client.
  • server-start -- Start the server here: http://localhost:3000/. Requests sent to this server will trigger a recompilation of the client code (not the server code).
  • server-start-reserve -- Start reserve to serve the app on http://localhost:12000/. In this setting, both changes to the client and server code will be automatically triggered by http requests. This is the ideal mode for running the app during compilation, however it has some caveats:
    • reserve crashes from time to time. Don't know why.
    • Currently the server has an in-memory fake database. Since reserve restarts the server for every request, nothing is persistant. (We should switch to a real database for this example.)
  • sensei-start -- Starts sensei. Needed for fast-test.
  • fast-test -- Recompiles the client and server code. And runs the test-suite. Meant to be run often after making changes to the code during development.

Caveats

example-servant-elm's People

Contributors

andys8 avatar soenkehahn avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.