doc/tutorial/index.rst · servant

git.iko.soy/servant

37 lines 1.2 kB history raw

1Tutorial

2========

4This is an introductory tutorial to **servant**. Whilst browsing is fine, it makes more sense if you read the sections in order, or at least read the first section before anything else.

6Any comments, issues or feedback about the tutorial can be submitted

7to `servant's issue tracker <http://github.com/haskell-servant/servant/issues>`_.

9In fact, the whole tutorial is a `cabal <https://cabal.readthedocs.io/en/latest/>`_

10project and can be built and played with locally as follows:

12.. code-block:: bash

14 $ git clone https://github.com/haskell-servant/servant.git

15 $ cd servant

16 # build

17 $ cabal new-build tutorial

18 # load in ghci to play with it

19 $ cabal new-repl tutorial

21The code can be found in the `*.lhs` files under `doc/tutorial/` in the

22repository. Feel free to edit it while you're reading this documentation and

23see the effect of your changes.

25`Nix <https://nixos.org/nix/>`_ users should feel free to take a look at

26the `nix/shell.nix` file in the repository and use it to provision a suitable

27environment to build and run the examples.

29.. toctree::

30 :maxdepth: 1

32 ApiType.lhs

33 Server.lhs

34 Client.lhs

35 Javascript.lhs

36 Docs.lhs

37 Authentication.lhs