haskell-servant/servant

Augment tutorial with a section about "real world applications"

Open

#826 opened on Oct 3, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (422 forks)batch import
documentationenhancementhelp wanted

Repository metrics

Stars
 (1,953 stars)
PR merge metrics
 (Avg merge 5h 49m) (2 merged PRs in 30d)

Description

It could for example show off several "best practices" or features (custom monad instead of Handler, custom error type instead of ServantErr, redirects, auth, other things?) through a todo-app like example.

cc @phadej @saurabhnanda

Contributor guide

Research direction
Write a tutorial section demonstrating real world best practices using a todo app example, covering custom monads, error types, redirects, auth, etc.
Tech stack
haskell
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HaskellServantGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70