4a6aedf88a
* Adds to the README seen on Github. * Adds to the README that will be seen on Stackage/Hackage. |
||
|---|---|---|
| .. | ||
| Yesod/Default | ||
| .gitignore | ||
| ChangeLog.md | ||
| LICENSE | ||
| README.md | ||
| Setup.lhs | ||
| yesod.cabal | ||
| Yesod.hs | ||
yesod
The yesod package groups together the various Yesod related packages into one cohesive whole. This is the "battery loaded" version of Yesod, whereas most of the core code lives in yesod-core.
For the yesod executable, see yesod-bin.
Yesod is fully documented on its website.
Getting Started
Learn more about Yesod on its main website. If you want to get started using Yesod, we strongly recommend the quick start guide, based on the Haskell build tool stack.
Here's a minimal example!
{-# LANGUAGE OverloadedStrings, QuasiQuotes, TemplateHaskell, TypeFamilies #-}
import Yesod
data App = App -- Put your config, database connection pool, etc. in here.
-- Derive routes and instances for App.
mkYesod "App" [parseRoutes|
/ HomeR GET
|]
instance Yesod App -- Methods in here can be overridden as needed.
-- The handler for the GET request at /, corresponds to HomeR.
getHomeR :: Handler Html
getHomeR = defaultLayout [whamlet|Hello World!|]
main :: IO ()
main = warp 3000 App
To read about each of the concepts in use above (routing, handlers, linking, JSON), in detail, visit Basics in the Yesod book.