Spock: Another Haskell web framework for rapid development

[ bsd3, library, web ] [ Propose Tags ]

This toolbox provides everything you need to get a quick start into web hacking with haskell:

A tutorial is available at spock.li


[Skip to Readme]
Versions 0.1.0.0, 0.1.1.0, 0.1.2.0, 0.2.0.0, 0.3.0.0, 0.4.0.0, 0.4.0.1, 0.4.1.0, 0.4.2.0, 0.4.2.1, 0.4.2.2, 0.4.2.3, 0.4.2.4, 0.4.3.0, 0.4.3.1, 0.4.3.2, 0.4.3.3, 0.4.3.4, 0.4.3.5, 0.4.4.0, 0.4.4.1, 0.5.0.0, 0.5.0.1, 0.5.1.0, 0.6.0.0, 0.6.1.0, 0.6.1.1, 0.6.1.2, 0.6.1.3, 0.6.2.0, 0.6.2.1, 0.6.2.2, 0.6.2.3, 0.6.3.0, 0.6.4.0, 0.6.5.0, 0.6.6.0, 0.6.6.1, 0.7.0.0, 0.7.1.0, 0.7.2.0, 0.7.3.0, 0.7.4.0, 0.7.5.0, 0.7.5.1, 0.7.5.2, 0.7.6.0, 0.7.7.0, 0.7.8.0, 0.7.9.0, 0.7.10.0, 0.7.11.0, 0.7.12.0, 0.8.0.0, 0.8.1.0, 0.9.0.0, 0.9.0.1, 0.10.0.0, 0.10.0.1, 0.11.0.0, 0.12.0.0, 0.13.0.0 (info)
Dependencies aeson (>=0.7), base (==4.*), base64-bytestring (>=1.0), bytestring (>=0.10), case-insensitive (>=1.1), containers (>=0.5), directory (>=1.2), focus (>=0.1), hashable (>=1.2), http-types (>=0.8), hvect (>=0.2), list-t (>=0.4), monad-control (>=1.0), mtl (>=2.1), old-locale (>=1.0), path-pieces (>=0.1.4), random (>=1.0), reroute (>=0.3), resource-pool (>=0.2), resourcet (>=0.4), stm (>=2.4), stm-containers (>=0.2), text (>=0.11.3.1), time (>=1.4), transformers (>=0.3), transformers-base (>=0.4), unordered-containers (>=0.2), vault (>=0.3), wai (>=3.0), wai-extra (>=3.0), warp (>=3.0) [details]
License BSD-3-Clause
Copyright (c) 2013 - 2015 Alexander Thiemann
Author Alexander Thiemann <mail@athiemann.net>
Maintainer Alexander Thiemann <mail@athiemann.net>
Category Web
Home page http://www.spock.li
Bug tracker https://github.com/agrafix/Spock/issues
Source repo head: git clone git://github.com/agrafix/Spock.git
Uploaded by AlexanderThiemann at Wed Aug 12 13:25:05 UTC 2015
Distributions NixOS:0.13.0.0
Downloads 25408 total (751 in the last 30 days)
Rating 2.5 (votes: 5) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2015-08-12 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for Spock-0.8.1.0

[back to package description]

Spock

Build Status

Hackage Deps

For more information and tutorials, visit spock.li

Intro

Hackage: Spock Tutorial: Spock Tutorial

Another Haskell web framework for rapid development: This toolbox provides everything you need to get a quick start into web hacking with haskell:

  • fast routing (both typesafe and "untyped")
  • middleware
  • json
  • sessions
  • cookies
  • database helper
  • csrf-protection

Benchmarks:

Usage (Typesafe, recommended)

{-# LANGUAGE OverloadedStrings #-}
import Web.Spock

import qualified Data.Text as T

main =
    runSpock 3000 $ spockT id $
    do get ("echo" <//> var) $ \something ->
        text $ T.concat ["Echo: ", something]

(read more at Type-safe routing in Spock)

Usage (Simple)

{-# LANGUAGE OverloadedStrings #-}
import Web.Spock.Simple

import qualified Data.Text as T

main =
    runSpock 3000 $ spockT id $
    do get ("echo" <//> ":something") $
        do Just something <- param "something"
           text $ T.concat ["Echo: ", something]
       get ("regex" <//> "{number:^[0-9]+$}") $
        do Just number <- param "number"
           text $ T.concat ["Just a number: ", number]

Install

  • Using cabal: cabal install Spock
  • From Source: git clone https://github.com/agrafix/Spock.git && cd Spock && cabal install

Candy

Extensions

The following Spock extensions exist:

Works well with Spock

Example Projects

Talks

Companies / Projects using Spock

Notes

Since version 0.7.0.0 Spock supports typesafe routing. If you wish to continue using the untyped version of Spock you can Use Web.Spock.Simple. The implementation of the routing is implemented in a separate haskell package called reroute.

Since version 0.5.0.0 Spock is no longer built on top of scotty. The design and interface is still influenced by scotty, but the internal implementation differs from scotty's.

Thanks to

  • Tim Baumann Github (lot's of help with typesafe routing)
  • Tom Nielsen Github (much feedback and small improvements)