Go to file
Denis Redozubov ce3e4f7193 Extract common code-generation stuff to servant-foreign 2015-09-21 20:59:09 +03:00
scripts Rename update-nix-files to generate-nix-files 2015-09-08 20:39:20 +01:00
servant Remove auto-generated nix files 2015-09-08 20:36:54 +01:00
servant-blaze Remove auto-generated nix files 2015-09-08 20:36:54 +01:00
servant-cassava Remove auto-generated nix files 2015-09-08 20:36:54 +01:00
servant-client Depend on transformers-compat 2015-09-12 16:28:20 +03:00
servant-docs ToSample instances for longer tuples (up to 7). 2015-09-16 12:45:51 +02:00
servant-examples Depend on transformers-compat 2015-09-12 16:28:20 +03:00
servant-foreign Extract common code-generation stuff to servant-foreign 2015-09-21 20:59:09 +03:00
servant-js Extract common code-generation stuff to servant-foreign 2015-09-21 20:59:09 +03:00
servant-lucid Remove auto-generated nix files 2015-09-08 20:36:54 +01:00
servant-mock Drop `EitherT` in favor of `ExceptT` 2015-09-12 15:11:24 +03:00
servant-server Document octet-stream default RFC. 2015-09-15 17:24:37 +02:00
.ghci added servant/.ghci 2014-10-31 15:49:05 +01:00
.gitignore Ignore auto-generated nix files 2015-09-08 20:37:49 +01:00
.stylish-haskell.yaml Contributing 2015-08-17 23:50:42 +02:00
.travis.yml make travis builds use stack 2015-09-06 09:04:55 -07:00
HLint.hs Contributing 2015-08-17 23:50:42 +02:00
README.md Don't self-promote at all 2015-09-20 14:14:09 +02:00
servant.png Update READMEs 2015-04-20 15:48:37 +02:00
sources.txt Extract common code-generation stuff to servant-foreign 2015-09-21 20:59:09 +03:00
stack-ghc-7.8.4.yaml make travis builds use stack 2015-09-06 09:04:55 -07:00
stack.yaml Extract common code-generation stuff to servant-foreign 2015-09-21 20:59:09 +03:00

README.md

servant - A Type-Level Web DSL

servant

Getting Started

We have a tutorial that introduces the core features of servant. After this article, you should be able to write your first servant webservices, learning the rest from the haddocks' examples.

Other blog posts, videos and slides can be found on the website.

If you need help, drop by the IRC channel (#servant on freenode) or mailing list.

Contributing

Contributions are very welcome! To hack on the github version, clone the repository. You can use cabal:

./scripts/start-sandbox.sh # Initialize the sandbox and add-source the packages
./scripts/test-all.sh      # Run all the tests

stack:

stack build    # Install and build packages
stack test     # Run all the tests

Or nix:

./scripts/generate-nix-files.sh   # Get up-to-date shell.nix files

Though we aren't sticklers for style, the .stylish-haskell.yaml and HLint.hs files in the repository provide a good baseline for consistency.

Please include a description of the changes in your PR in the CHANGELOG.md of the packages you've changed. And of course, write tests!