Snap is a web framework for Haskell, based on iteratee I/O (as popularized by
Oleg Kiselyov). For more
information about Snap, read the README.SNAP.md or visit the Snap project
website at http://www.snapframework.com/.
This is top-level project for the Snap Framework, 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.
-
a "snaplet" API allowing web applications to be build from composable pieces.
The snap tool and library are built using Cabal and Hackage. Just run
cabal install
from the snap toplevel directory.
The haddock documentation can be built using 'cabal haddock'.
The docs get put in dist/doc/html/.
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:
$ ./runTestsAndCoverage.sh
The testsuite generates an hpc test coverage report in test/dist/hpc.
- Read Tutorial.lhs which is in
project_template/tutorial/src. - Generate and read the haddock docs.
- 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.