firefly-example: A simple example using Firefly

[ bsd3, program, web ] [ Propose Tags ]
Dependencies aeson, base (>=4.7 && <5), blaze‑html, firefly, mtl, text, wai [details]
License BSD-3-Clause
Copyright 2017 Chris Penner
Author Chris Penner
Category Web
Home page
Source repo head: git clone
Uploaded by ChrisPenner at Fri Sep 8 00:45:39 UTC 2017
Distributions NixOS:
Executables firefly-example-exe
Downloads 176 total (5 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
Last success reported on 2017-09-08 [all 3 reports]
Hackage Matrix CI

[Skip to Readme]


Maintainer's Corner

For package maintainers and hackage trustees

Readme for firefly-example-

[back to package description]


Firefly is dead simple http framework written in Haskell.

It strives for simplicity in implementation (and in use). It's great for people learning Haskell, fiddling with Monads, or who just need a really simple server for something.

Here's the minimal app:

{-# language OverloadedStrings #-}
import Web.Firefly
import qualified Data.Text as T

main :: IO ()
main = run 3000 app

app :: App ()
app = do
  route "/hello" (return "hello" :: Handler T.Text)

Just that easy!

Check out the Example App for more!

Specify your routes using regex patterns, the first one which matches will run.

Handler is a monad with access to the incoming request. You can access parts of it using helpers, then return a response.

Here are some valid response types and their inferred Content-Type

  • Data.Text.Text: text/plain
  • Data.Aeson.Value: application/json
  • Blaze.Html.Html: text/html

There are more in Web.Firefly.Response.

You can specify your status code using (body, Status) where body is any of the above types and Status is an Integer status code.

Or, add headers too with (body, Status, HeaderMap) where HeaderMap is a map of names to values.


Let's write some more interesting handlers:

hello :: App T.Text
hello = do
  -- | Get the 'name' query param from the url, if it doesn't exist use 'Stranger'
  name <- getQuery "name"
  -- If we just return some Text the response will be status 200 with a Content-Type of "text/plain"
  return $ "Hello " <> fromMaybe "Stranger" name

Here's an example of responding with JSON:

import Data.Aeson (ToJSON, FromJSON)
import GHC.Generics (Generic)
import qualified Data.Text as T
import qualified Network.Wai as W
import Web.Firefly

data User = User
  { username::T.Text
  , age::Int
  } deriving (Generic, ToJSON, FromJSON) -- Derive JSON instances

-- A reguler 'ol user
steve :: User
steve = User{username="Steve", age=26}

-- | Get a user by username
getUser :: App W.Response
getUser = do
  uname <- getQuery "username"
  return $ case uname of
             -- The Json constructor signals to serialize the value and respond as "application/json"
             Just "steve" -> toResponse $ Json steve 
             Just name -> toResponse ("Couldn't find user: " `mappend` name, notFound404)
             Nothing -> toResponse ("Please provide a 'username' parameter" :: T.Text, badRequest400)

Should I/Shouldn't I use Firefly?

You should use Firefly if:

  • You're intimidated by monads and want to learn more!
  • You want to write a hobby project
  • You like understanding the stack you're working with (The whole lib is ~300 lines without docs/imports)

Don't use Firefly if:

  • You'll have thousands of users
  • You want the most performant server possible
  • You want to have lots of helper libs available