Difference between revisions of "Web/Frameworks"

From HaskellWiki
< Web
Jump to: navigation, search
(Fix Happstack documentation link)
(Added the IHP Framework)
(One intermediate revision by the same user not shown)
Line 7: Line 7:
   
 
See also: there are also many [[Web/Frameworks/Inactive|inactive web frameworks]] to draw inspiration from
 
See also: there are also many [[Web/Frameworks/Inactive|inactive web frameworks]] to draw inspiration from
  +
  +
== IHP: Integrated Haskell Platform ==
  +
  +
IHP is a modern batteries-included web framework using haskell and nix. It comes with everything you need to build great web applications out of the box. Combined with the unique mix of technologies and a fast development process, IHP makes it very pleasant to build applications.
  +
  +
The development environment is fully managed, so you don't need to worry about installing GHC, Cabal or other haskell tools. The built-in web server automatically reloads your haskell code, no need to manually recompile your app. Thanks to code generators and it's great documentation you can build real web applications with very basic knowledge of haskell. You will pick up more advanced Haskell along the way!
  +
  +
Notable features:
  +
*HSX, a JSX-like template language that looks like HTML while providing type safety
  +
*Auto live reloading without the need to setup anything
  +
*Documentation with examples: it lets you query the database without learning about monads
  +
*Type-safe, composable SQL queries
  +
*Active community that can help you with type errors
  +
*IHP runs on MacOS, Windows and Linux.
  +
 
{| class="wikitable"
 
! License
 
| MIT
 
|-
 
! Author:
  +
| digitally induced GmbH and Open Source Contributors
  +
|-
 
! Maintainer:
  +
| digitally induced GmbH
  +
|-
 
! Home page:
  +
| https://ihp.digitallyinduced.com/
  +
|-
 
! Documentation:
  +
| https://ihp.digitallyinduced.com/Guide/
  +
|-
 
! Package & repositories
 
| [https://github.com/digitallyinduced/ihp]
 
|}
  +
  +
Join the [https://gitter.im/digitallyinduced/ihp Gitter Community] or [https://forum.ihpapp.com/ the IHP Forum] to get help while building your application.
   
 
== Happstack ==
 
== Happstack ==
Line 119: Line 155:
   
 
You can see a [https://github.com/yesodweb/yesod/wiki/Powered-by-Yesod list of Yesod-powered sites and packages], or check out the [https://github.com/snoyberg/haskellers source code for Haskellers]. Most discussions for Yesod take place on the [http://groups.google.com/group/yesodweb yesodweb list], so feel free to join in and ask any questions you have, the Yesod community is very beginner-friendly.
 
You can see a [https://github.com/yesodweb/yesod/wiki/Powered-by-Yesod list of Yesod-powered sites and packages], or check out the [https://github.com/snoyberg/haskellers source code for Haskellers]. Most discussions for Yesod take place on the [http://groups.google.com/group/yesodweb yesodweb list], so feel free to join in and ask any questions you have, the Yesod community is very beginner-friendly.
 
== miku ==
 
 
A simple library for fast web prototyping in Haskell, inspired by Ruby's Rack and Sinatra.
 
 
{| class="wikitable"
 
! License
 
| BSD3
 
|-
 
! Author
 
| Wang, Jinjing
 
|-
 
! Maintainer
 
| Wang, Jinjing <nfjinjing@gmail.com>
 
|-
 
! Package & repositories
 
| [http://hackage.haskell.org/package/miku Hackage] - [http://github.com/nfjinjing/miku Github]
 
|}
 
 
== Lemmachine ==
 
 
Lemmachine is a REST'ful web framework that makes it easy to get HTTP right by exposing users to overridable hooks with sane defaults. The main architecture is a copy of Erlang-based Webmachine, which is currently the best documentation reference (for hooks & general design).
 
 
Lemmachine stands out from the dynamically typed Webmachine by being written in dependently typed Agda. The goal of the project is to show the advantages gained from compositional testing by taking advantage of proofs being inherently compositional. See proofs for examples of universally quantified proofs (tests over all possible input values) written against the default resource, which does not override any hooks.
 
 
[http://github.com/larrytheliquid/Lemmachine#readme More information]
 
 
{| class="wikitable"
 
! Author
 
| Larry Diehl
 
|-
 
! Packages & repositories
 
| [http://github.com/larrytheliquid/Lemmachine Github]
 
|}
 
   
 
== mohws ==
 
== mohws ==
Line 173: Line 175:
 
!Packages & repositories
 
!Packages & repositories
 
|[http://hackage.haskell.org/cgi-bin/hackage-scripts/package/mohws Hackage] - [http://code.haskell.org/mohws/ Darcs]
 
|[http://hackage.haskell.org/cgi-bin/hackage-scripts/package/mohws Hackage] - [http://code.haskell.org/mohws/ Darcs]
|}
 
 
== Salvia ==
 
 
Salvia is a feature rich modular web server and web application framework that can be used to write dynamic websites in Haskell. From the lower level protocol code up to the high level application code, everything is written as a Salvia handler. This approach makes the server extremely extensible. To see a demo of a Salvia website, please see the salvia-demo package.
 
 
All the low level protocol code can be found in the salvia-protocol package, which exposes the datatypes, parsers and pretty-printers for the URI, HTTP, Cookie and MIME protocols.
 
 
This Salvia package itself can be separated into three different parts: the interface, the handlers and the implementation. The interface module defines a number of type classes that the user can build the web application against. Reading the request object, writing to the response, or gaining direct access to the socket, all of these actions are reflected using one type class aspect in the interface. The handlers are self contained modules that implement a single aspect of the Salvia web server. The handlers expose their interface requirements in their type context. Salvia can have multiple implementations which can be switched by using different instances for the interface type classes. This package has only one implementation, a simple accepting socket loop server. The salvia-extras package has two additional implementations. Keeping a clear distinction between the abstract server aspects and the actual implementation makes it very easy to migrate existing web application to different back-ends.
 
 
{| class="wikitable"
 
! License:
 
| BSD3
 
|-
 
! Author:
 
| Sebastiaan Visser
 
|-
 
! Maintainer:
 
| sfvisser@cs.uu.nl
 
|-
 
! Announcement:
 
| http://www.haskell.org/pipermail/haskell-cafe/2010-March/074870.html
 
|-
 
! Package & repositories
 
| [http://hackage.haskell.org/package/salvia Hackage] - [http://github.com/sebastiaanvisser/salvia Git]
 
 
|}
 
|}
   
Line 252: Line 229:
 
| [http://hackage.haskell.org/package/miso Hackage] - [https://github.com/dmjio/miso Git]
 
| [http://hackage.haskell.org/package/miso Hackage] - [https://github.com/dmjio/miso Git]
 
|}
 
|}
 
   
 
== Servant ==
 
== Servant ==
Line 274: Line 250:
 
! Package & repositories
 
! Package & repositories
 
| [http://hackage.haskell.org/package/servant Hackage] - [https://github.com/haskell-servant Git]
 
| [http://hackage.haskell.org/package/servant Hackage] - [https://github.com/haskell-servant Git]
|}
 
 
== MFlow==
 
 
A Haskell application server ++ Web Framework. MFlow is a shorthand for "Message Flow". It is a continuation-based framework without continuations. Instead of other continuation based frameworks like Ocsigen(Ocaml), Coccoon (javascript) or Seaside (Smalltalk), it is based on a backtracking monad that keep the synchornization of the execution state with the user navigation. Since the discontinuation of [http://www.informatik.uni-freiburg.de/~thiemann/WASH/ WASH], MFlow is the only continuation-style framework written in Haskell to date.
 
 
Unlike real continuations, the state in MFlow applications is pretty small and serializable, so it is horizontally scalable. The navigation in a MFlow application is safe at compilation time, since even the internal HTML links are checked by the compiler. The code is very short and has little configuration. Routes in MFlow are defined and typechecked in pure haskell code, just like in the case of the menus in a console application. Each page has its own URL so it is RESTful to a certain extent. It is planned to have REST-style URLs in the future (done in the head of the github repo).
 
 
It uses standard Haskell web libraries and/or techniques: WAI, Warp, Blaze HTML, HSP. Its core is server and rendering independent. A kind of extended [http://groups.inf.ed.ac.uk/links/formlets/ formlets] are used to create self contained components, called widgets. They have formatting, Ajax, and server code. They can be composed to create the user interface.
 
 
A MFlow application resembles a console application. This is an example of a complete application with three pages. It ask for two numbers and return the sum. At any time, even if the user press the back button, the state is synchronized with the navigation.
 
 
module Main where
 
import MFlow.Wai.Blaze.Html.All
 
 
main= do
 
addMessageFlows [("sum", transient . runFlow $ sumIt )]
 
wait $ run 8081 waiMessageFlow
 
 
sumIt= do
 
setHeader $ html . body
 
n1 <- ask $ p << "give me the first number"
 
++> getInt Nothing
 
<** submitButton "send"
 
 
n2 <- ask $ p << "give me the second number"
 
++> getInt Nothing
 
<** submitButton "send"
 
 
ask $ p << ("the result is " ++ show (n1 + n2))
 
++> wlink () << p << "click here"
 
 
 
 
{| class="wikitable"
 
! License:
 
| BSD3
 
|-
 
! Author:
 
| Alberto Gómez Corona
 
|-
 
! Maintainer:
 
| Alberto Gómez Corona
 
|-
 
! Home page:
 
| http://haskell-web.blogspot.com
 
|-
 
! Documentation:
 
| http://hackage.haskell.org/package/MFlow
 
[https://docs.google.com/file/d/0B2-x2MmiuA32b0RndnZTdTVUb0E MFlow paper]
 
|-
 
! Package & repositories
 
| [http://hackage.haskell.org/package/MFlow Hackage] - [https://github.com/agocorona/MFlow Git]
 
 
|}
 
|}
   
Line 356: Line 279:
 
! Package & repositories
 
! Package & repositories
 
| [http://hackage.haskell.org/package/Spock Hackage] - [https://github.com/agrafix/Spock Git]
 
| [http://hackage.haskell.org/package/Spock Hackage] - [https://github.com/agrafix/Spock Git]
|}
 
 
== Wheb ==
 
 
Wheb's a WAI framework for building robust, high-concurrency web applications simply and effectively. Its primary goal is to extend the functionality of the base WAI library and to provide an easy entry point into Haskell web servers. The only prerequisite is "Learn you a Haskell" or another introductory Haskell course. It comes with lots of examples on the github page.
 
 
* The core datatype will let you build anything from a read-only server to a fully interactive web application with basic Haskell.
 
* Minimal boilerplate to start your application.
 
* Session, Auth and Cache interfaces are built in. Just drop in a backend.
 
* Choice between type-safe web-routes or simpler pattern-based named-routes.
 
* Easy to use for REST APIs
 
* WebSockets
 
* Fully database and template agnostic
 
* Easy handler debugging.
 
* Middleware
 
 
Wheb makes it easy to write plugins. Plugins can add routes, middleware, settings and even handle resource cleanup on server shutdown. Named routes allow plugins to dynamically generate their routes at runtime based on settings.
 
 
* Sessions
 
* Auth
 
* Cache
 
* [http://hackage.haskell.org/package/wheb-mongo Wheb-Mongo]
 
* [http://hackage.haskell.org/package/wheb-redis Wheb-Redis]
 
* [http://hackage.haskell.org/package/wheb-strapped Wheb-Strapped]
 
 
{| class="wikitable"
 
! License:
 
| BSD3
 
|-
 
! Author:
 
| Kyle Hanson
 
|-
 
! Maintainer:
 
| Kyle Hanson
 
|-
 
! Home page:
 
| https://github.com/hansonkd/Wheb-Framework
 
|-
 
! Documentation:
 
| http://hackage.haskell.org/package/Wheb
 
|}
 
 
 
== WebApi ==
 
 
WebApi is a light weight, WAI based library that lets you define your requests and responses for end-points as types by means of a contract. The contract is considered the single source of truth, using which WebApi lets you to
 
 
* Write Web/REST API services
 
* Generate Haskell client for existing API services
 
* Generate mock server to mock requests and responses
 
 
WebApi makes use of the strong type system of haskell which lets to
 
 
* Create a type safe routing system.
 
* Enable type safe generation of links.
 
* Specify a contract for the APIs.
 
* Auto serialization and deserialization of the request and response based on api contract.
 
* Write handlers which respect the contract.
 
 
 
{| class="wikitable"
 
! License:
 
| BSD3
 
|-
 
! Author:
 
| ByteAlly Software Pvt Ltd
 
|-
 
! Maintainer:
 
| ByteAlly team
 
|-
 
! Home page:
 
| http://byteally.github.io/webapi/
 
|-
 
! Documentation:
 
| http://byteally.github.io/webapi/
 
|-
 
! Package & repositories
 
| [https://hackage.haskell.org/package/webapi Hackage] - [https://github.com/byteally/webapi Git]
 
 
|}
 
|}
   

Revision as of 07:41, 27 August 2020

Haskell Web Development

Software:
Servers - Libraries - Frameworks
Deploy - Cloud
Interfaces to frameworks
Databases and Persistence
Testing and Verification
Content Management

Community & Research:
Forums and Discussion
Literature (research, talks and blogs)
Existing Haskell web applications
Ongoing projects and ideas

Content from Web should be merged here.

Below is a list of known to be active Haskell web frameworks. Rather than one framework to rule them all, Haskell provides several options. You can view the Web/Deploy page to get an idea of how you might deploy an application written in some of these frameworks.

See also: there are also many inactive web frameworks to draw inspiration from

IHP: Integrated Haskell Platform

IHP is a modern batteries-included web framework using haskell and nix. It comes with everything you need to build great web applications out of the box. Combined with the unique mix of technologies and a fast development process, IHP makes it very pleasant to build applications.

The development environment is fully managed, so you don't need to worry about installing GHC, Cabal or other haskell tools. The built-in web server automatically reloads your haskell code, no need to manually recompile your app. Thanks to code generators and it's great documentation you can build real web applications with very basic knowledge of haskell. You will pick up more advanced Haskell along the way!

Notable features:

  • HSX, a JSX-like template language that looks like HTML while providing type safety
  • Auto live reloading without the need to setup anything
  • Documentation with examples: it lets you query the database without learning about monads
  • Type-safe, composable SQL queries
  • Active community that can help you with type errors
  • IHP runs on MacOS, Windows and Linux.
License MIT
Author: digitally induced GmbH and Open Source Contributors
Maintainer: digitally induced GmbH
Home page: https://ihp.digitallyinduced.com/
Documentation: https://ihp.digitallyinduced.com/Guide/
Package & repositories [1]

Join the Gitter Community or the IHP Forum to get help while building your application.

Happstack

Happstack is a Haskell web framework. Happstack is designed so that developers can prototype quickly, deploy painlessly, scale massively, operate reliably, and change easily. It supports GNU/Linux, OS X, FreeBSD, and Windows environments.

License BSD3
Author: Happstack team, HAppS LLC
Maintainer: Happstack team <happs@googlegroups.com>
Home page: http://happstack.com/
Documentation: http://happstack.com/page/view-page-slug/3/documentation
Package & repositories Hackage - Darcs

Happstack is a complete web framework. The main component is happstack-server: an integrated HTTP server, routing combinators, fileserving, etc. In addition, a number of packages that used to be coupled to Happstack have now been decoupled from it, but remain promoted and documented for use with Happstack:

  • safecopy: datatype serialization and migration support
  • acid-state: a powerful NoSQL ACID storage system with native support for Haskell types

It also includes integration with many 3rd party libraries including:

See the Happstack Home Page for more information and to learn how to get support via IRC and mailing lists.

Snap

Snap is a web development framework built around an abstraction called snaplets.

Snap is well-documented and has a test suite with a high level of code coverage. It has been used in production for years, and version 1.0 was released in August 2016. As of July 2017, it does not support HTTP/2.

The framework provides:

  • A fast HTTP server library
  • A sensible and clean monad for web programming
  • A simple, yet powerful template system that supports both HTML5 and XML

Snaplets that come with the framework include functionality for templating, authentication and sessions. Additional functionality (including MySQL and PostgreSQL database access) is provided by third-party snaplets.

License: BSD3
Author: James Sanders, Gregory Collins, Doug Beardsley
Maintainer: snap@snapframework.com
Home page: http://snapframework.com/
Documentation: http://snapframework.com/docs
Package & repositories Hackage - Git

Yesod

Yesod is designed for RESTful, type-safe, performant web apps. By leveraging quasi-quotation for the more boilerplate tasks, we get concise web apps with high levels of type safety. Its Hamlet templates are compile-time checked for correctness, and the controller (web-routes-quasi) uses type-safe URLs to make certain you are only generating valid URLs. It loosely follows Model/View/Controller principles.

License: BSD3
Author: Michael Snoyman <michael@snoyman.com>
Maintainer: Michael Snoyman <michael@snoyman.com>
Announcement: http://www.haskell.org/pipermail/haskell-cafe/2010-March/074271.html
Home page: http://www.yesodweb.com/
Documentation: http://www.yesodweb.com/book
Screencast: http://www.yesodweb.com/page/screencasts
Package & repositories Hackage - Github

Yesod is a full-featured web framework. It takes a modular approach to development, so many parts of the framework such as Hamlet and Persistent are available as standalone packages. However, put together, Yesod provides you with solutions for templating, routing, persistence, sessions, JSON, authentication/authorization, and more. Yesod's major guiding principle is type safety: if your application compiles, it works.

Yesod is very well documented through a combination of haddocks and the Yesod book.

Yesod is built on WAI, or the Web Application Interface. This is similar to WSGI in Python or Rack in Ruby. It provides a single interface that all applications can target and work on multiple backends. Backends exist for CGI, FastCGI, SCGI, development server (auto-recompile) and even a Webkit-powered desktop version.

But the premier backend is Warp: a very simple web server which, at the time of writing, is the fastest Haskell has to offer. You can read more in its release announcement and see some followup benchmarks. Warp is already powering Yesod; some other major players that are planning a move are Hoogle and Happstack.

You can see a list of Yesod-powered sites and packages, or check out the source code for Haskellers. Most discussions for Yesod take place on the yesodweb list, so feel free to join in and ask any questions you have, the Yesod community is very beginner-friendly.

mohws

A web server with a module system and support for CGI. Based on Simon Marlow's original Haskell Web Server.

License: BSD3
Copyright: Simon Marlow, Bjorn Bringert
Author: Simon Marlow, Bjorn Bringert <bjorn@bringert.net>
Maintainer: Henning Thielemann <webserver@henning-thielemann.de>
Packages & repositories Hackage - Darcs

Scotty

A Haskell web framework inspired by Ruby's Sinatra, using WAI and Warp. Sinatra + Warp = Scotty.

Scotty is simple, cheap and cheerful way to write RESTful, declarative web applications. It has good documentation for all the relevant functions.

  • A page is as simple as defining the verb, url pattern, and Text content.
  • It is template-language agnostic. Anything that returns a Text value will do.
  • Conforms to WAI Application interface.
  • Uses very fast Warp webserver by default.
License: BSD3
Author: Andrew Farmer
Maintainer: Andrew Farmer
Home page: https://github.com/scotty-web/scotty
Documentation: http://hackage.haskell.org/package/scotty
Package & repositories Hackage - Git

Miso

Miso is a small "isomorphic" Haskell front-end framework featuring a virtual-dom, diffing / patching algorithm, event delegation, event batching, SVG, Server-sent events, Websockets, and an extensible Subscription-based subsystem. Inspired by Elm, Redux and Bobril. IO and other effects (like XHR) can be introduced into the system via the Effect data type. Miso makes heavy use of the GHCJS FFI and therefore has minimal dependencies.


License: BSD3
Author: David Johnson
Maintainer: djohnson.m@gmail.com
Home page: https://github.com/dmjio/miso
Package & repositories Hackage - Git

Servant

Servant is a a light-weight framework primarily for REST APIs. It allows to specify API specifications as type aliases and then work with these type aliases to create servers, but also documentation, client code in Haskell and Javascript, etc.. It is based on wai.


License: BSD3
Author: Alp Mestanogullari, Sönke Hahn, Julian K. Arni
Maintainer: alpmestan@gmail.com
Home page: http://haskell-servant.github.io/
Package & repositories Hackage - Git

Spock

Another Haskell web framework for rapid development: This toolbox provides everything you need to get a quick start into web hacking with haskell: routing, middleware, json, blaze, sessions, cookies, database helper, csrf-protection, global state

  • Simple API
  • Adds lots of useful features for rapid web development
  • Fast tree based routing
  • Plugins like Spock-auth and Spock-worker
License: BSD3
Author: Alexander Thiemann
Maintainer: Alexander Thiemann
Home page: https://github.com/agrafix/Spock
Documentation: http://hackage.haskell.org/package/Spock
Package & repositories Hackage - Git

See also