Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Minimum viable Erlang web framework

branch: master
README.md

Spooky Spooky

Synopsis

Spooky is a lightweight and dead easy to use RESTful request handler for Erlang.

It's using the Misultin http library and provides request handling similar to the Sinatra web framework.

hello_world.erl

    -module(hello_world).
    -behaviour(spooky).
    -export([init/1, get/2]).

    init([])->
        [{port, 8000}].

    get(Req, [])->
        Req:ok("Hello world.");
    get(_, ["smashingpumpkins"])->
        throw({418, "I'm a teapot."});
    get(Req, [Name])->
        Req:ok("Hello world, " ++ Name ++ ".").

shell

    $ make && erlc -pa ebin/ hello_world.erl && erl -pa ebin/ -pa deps/*/ebin
    [...]
    1> spooky:start_link(hello_world)
    {ok, <0.40.0>}
    2> spooky:stop()
    true

Features

  • Modular
    Split your web application up into different, reusable modules. Say, for user management, mnesia administration or login logic.

  • RESTful request handling/routing

    • Use get/post/put/delete/head methods for a clean seperation of your HTTP API
    • Use pattern matching to handle requests to different URLs
  • Middlewares
    Use chained middlewares to preprocess the request before it arrives at your handlers and modify or abort it on the fly.

  • Erlang
    Dead simple interfacing to your gen_servers, gen_fsms and gen_events

Todo

  • Write documentation

Why?

Scratching an itch. Spooky is as simple as it gets - you're left to deal with everything else than request handling. If this is not what you are looking for and need things like ORM support, templating, etc, you should look at other frameworks:

Thanks

Thanks to Learn you some Erlang, Mochiweb, Misultin and CouchDB for being excellent repositories to learn about Erlang.

Something went wrong with that request. Please try again.