git.iko.soy/typeable/servant
on master help sign in
typeable/servant/README.md
71 lines 2.8 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://docs.servant.dev/en/stable/tutorial/index.html) 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.
12The core documentation can be found [here](http://docs.servant.dev/).
13Other blog posts, videos and slides can be found on the
14[website](http://www.servant.dev/).
16If you need help, drop by the IRC channel (#haskell-servant on libera.chat) or [mailing
17list](https://groups.google.com/forum/#!forum/haskell-servant).
19## Contributing
21See `CONTRIBUTING.md`
23## Release process outline (by phadej)
25- Update changelog and bump versions in `master`
26 - `git log --oneline v0.12.. | grep 'Merge pull request'` is a good starting point (use correct previous release tag)
27- Create a release branch, e.g. `release-0.13`
28 - Release branch is useful for backporting fixes from `master`
29- Smoke test in [`servant-universe`](https://github.com/phadej/servant-universe)
30 - `git submodule foreach git checkout master` and `git submodule foreach git pull` to get newest of everything.
31 - `cabal new-build --enable-tests all` to verify that everything builds, and `cabal new-test all` to run tests
32 - It's a good idea to separate these steps, as tests often pass, if they compile :)
33 - See `cabal.project` to selectively `allow-newer`
34 - If some packages are broken, on your discretisation there are two options:
35 - Fix them and make PRs: it's a good idea to test against older `servant` version too.
36 - Temporarily comment out broken package
37 - If you make a commit for `servant-universe`, you can use it as submodule in private projects to test even more
38- When ripples are cleared out:
39 - `git tag -s` the release
40 - `git push --tags`
41 - `cabal sdist` and `cabal upload`
43## TechEmpower framework benchmarks
45We develop and maintain the servant TFB entry in https://github.com/haskell-servant/FrameworkBenchmarks/
47To verify (i.e. compile and test that it works)
49```sh
50./tfb --mode verify --test servant servant-beam servant-psql-simple --type json plaintext db fortune
51```
53To compare with `warp`
55```sh
56./tfb --mode benchmark --test warp servant servant-beam servant-psql-simple --type json plaintext db fortune
57```
59To compare with `reitit` (Clojure framework)
61```sh
62./tfb --mode benchmark --test reitit reitit-async reitit-jdbc servant servant-beam servant-psql-simple --type json plaintext db fortune
63```
65You can see the visualised results at https://www.techempower.com/benchmarks/#section=test
67## Nix
69A developer shell.nix file is provided in the `nix` directory
71See [nix/README.md](nix/README.md)