The miku package

[Tags:bsd3, library]

A simple library for fast web prototyping in Haskell.


[Skip to Readme]

Properties

Versions 2011.6.11, 2011.6.12, 2011.6.15, 2011.6.18, 2011.6.19, 2011.6.20, 2011.6.24, 2012.1.19, 2012.10.27, 2014.4.14, 2014.5.19, 2014.11.17, 2016.3.16, 2016.3.16.1, 2016.3.17
Change log changelog.md
Dependencies air (>=2011.6.19), base (>4 && <=99), bytestring, containers, data-default, hack2 (>=2012.1.19), hack2-contrib (>=2012.1.19), mtl, utf8-string [details]
License BSD3
Author Jinjing Wang
Maintainer Jinjing Wang <nfjinjing@gmail.com>
Stability Unknown
Category Web
Home page https://github.com/nfjinjing/miku
Uploaded Tue Dec 18 11:42:49 UTC 2012 by JinjingWang
Distributions NixOS:2016.3.17
Downloads 2204 total (69 in the last 30 days)
Votes
0 []
Status Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for miku

Readme for miku-2012.10.27

miku

A tiny web dev DSL

Example

{-# LANGUAGE OverloadedStrings #-}

import Network.Miku
import Hack2.Handler.SnapServer

main = run . miku $ get "/" (text "miku power")

Installation

cabal update
cabal install miku
cabal install hack2-handler-snap-server

-- copy and paste the above example to myapp.hs

runghc myapp.hs

check: http://localhost:3000

Quick reference

https://github.com/nfjinjing/miku/blob/master/src/Test/Test.hs

Routes

Verbs

{-# LANGUAGE OverloadedStrings #-}

-- use - instead of $ for clarity
import Air.Light ((-))
import Prelude hiding ((-))

import Network.Miku
import Hack2.Handler.SnapServer

main = run . miku - do

  get "/" - do
    -- something for a get request

  post "/" - do
    -- for a post request

  put "/" - do
    -- put ..

  delete "/" - do
    -- ..

Captures

get "/say/:user/:message" - do
  text . show =<< captures

-- /say/miku/hello will output
-- [("user","miku"),("message","hello")]

Static

-- public serve, only allows `./src`
public (Just ".") ["/src"]

Mime types

-- treat .hs extension as text/plain
mime "hs" "text/plain"

Filters

-- before takes a function of type (Env -> IO Env)
before - \e -> do
  putStrLn "before called"
  return e

-- after takes that of type (Response -> IO Response)
after return

Hack2 integration

Use hack2 middleware

import Hack2.Contrib.Middleware.SimpleAccessLogger

middleware - simple_access_logger Nothing

Convert miku into a hack2 application

-- in Network.Miku.Engine

miku :: MikuMonad -> Application

Miku application template

This template project shows how to incorporate sandboxing, auto-reloading and other cool stuff.

https://github.com/nfjinjing/miku-template

Hints

  • It's recommended to use your own html combinator / template engine. Try DIY with, e.g. moe.
  • Example view using custom html combinator (moe in this case)
  • When inspecting the request, use ask defined in ReaderT monad to get the Hack2.Environment, then use helper method defined in Hack2.Contrib.Request to query it.
  • Response is in StateT, html and text are simply helper methods that update the state, i.e. setting the response body, content-type, etc.
  • You do need to understand monad transformers to reach the full power of miku.

Reference