NOTE: 0.6 requires Chris Smith's fork of the configurator package. It is available here:
This is the first developer prerelease of the Snap Framework snap
tool. For more information about Snap, read the
visit the Snap project website at http://www.snapframework.com/.
Snap is a nascent web framework for Haskell, based on iteratee I/O (as popularized by Oleg Kiselyov).
This is the
snap executable and supporting library, which contains:
a command-line utility for creating initial Snap applications
a library allowing Snap applications to recompile actions on the fly in development mode, with no performance loss in production mode.
snap toplevel directory.
Building the Haddock Documentation
The haddock documentation can be built using the supplied
The docs get put in
Building the testsuite
Snap is still in its very early stages, so most of the "action" (and a big chunk of the code) right now is centred on the test suite. Snap aims for 100% test coverage, and we're trying hard to stick to that.
To build the test suite,
cd into the
test/ directory and run
$ cabal configure $ cabal build
From here you can invoke the testsuite by running:
The testsuite generates an
hpc test coverage report in
Roadmap to Understanding Snaplets
- Read tutorial.md.
- Generate and read the haddock docs.
- Look at the code in the example directory, and the example applications in the test directory. The test code has the nice property that it actually functions as a pretty good example app and covers a lot of the use cases.
- If you're interested in the implementation, read design.md.