git.iko.soy/typeable/servant
on e17987e help sign in
typeable/servant/README.md
45 lines 1.4 kB history raw
1# servant - A Type-Level Web DSL
3![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)
5## Getting Started
7We have a [tutorial](http://haskell-servant.github.io/tutorial) that
8introduces the core features of servant. After this article, you should be able
9to write your first servant webservices, learning the rest from the haddocks'
10examples.
12Other blog posts, videos and slides can be found on the
13[website](http://haskell-servant.github.io/).
15If you need help, drop by the IRC channel (#servant on freenode) or [mailing
16list](https://groups.google.com/forum/#!forum/haskell-servant).
18## Contributing
20Contributions are very welcome! To hack on the github version, clone the
21repository. You can use `cabal`:
23```shell
24./scripts/start-sandbox.sh # Initialize the sandbox and add-source the packages
25./scripts/test-all.sh # Run all the tests
26```
28`stack`:
30```shell
31stack build # Install and build packages
32stack test # Run all the tests
33```
35Or `nix`:
36```shell
37./scripts/generate-nix-files.sh # Get up-to-date shell.nix files
38```
40Though we aren't sticklers for style, the `.stylish-haskell.yaml` and `HLint.hs`
41files in the repository provide a good baseline for consistency.
43Please include a description of the changes in your PR in the `CHANGELOG.md` of
44the packages you've changed. And of course, write tests!