jlamothe/dmfix
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
DiscussMormonism.com link fixer
3 Commits 2 Branches 2 Tags 190 KiB
Haskell 100%
Go to file
Jonathan Lamothe 409cb38385 hlint suggestions 2021-09-21 21:06:48 -04:00
app initial commit 2021-09-21 16:22:34 -04:00
config initial commit 2021-09-21 16:22:34 -04:00
src hlint suggestions 2021-09-21 21:06:48 -04:00
static initial commit 2021-09-21 16:22:34 -04:00
templates initial commit 2021-09-21 16:22:34 -04:00
test hlint suggestions 2021-09-21 21:06:48 -04:00
.dir-locals.el initial commit 2021-09-21 16:22:34 -04:00
.gitignore initial commit 2021-09-21 16:22:34 -04:00
ChangeLog.md initial commit 2021-09-21 16:22:34 -04:00
LICENSE switch to GPLv3 2021-09-21 17:49:05 -04:00
package.yaml switch to GPLv3 2021-09-21 17:49:05 -04:00
README.md initial commit 2021-09-21 16:22:34 -04:00
stack.yaml initial commit 2021-09-21 16:22:34 -04:00
stack.yaml.lock initial commit 2021-09-21 16:22:34 -04:00

README.md

Haskell Setup

  1. If you haven't already, install Stack
    • On POSIX systems, this is usually curl -sSL https://get.haskellstack.org/ | sh
  2. Install the yesod command line tool: stack install yesod-bin --install-ghc
  3. Build libraries: stack build

If you have trouble, refer to the Yesod Quickstart guide for additional detail.

Development

Start a development server with:

stack exec -- yesod devel

As your code changes, your site will be automatically recompiled and redeployed to localhost.

Tests

stack test --flag dmfix:library-only --flag dmfix:dev

(Because yesod devel passes the library-only and dev flags, matching those flags means you don't need to recompile between tests and development, and it disables optimization to speed up your test compile times).

Documentation

  • Read the Yesod Book online for free
  • Check Stackage for documentation on the packages in your LTS Haskell version, or search it using Hoogle. Tip: Your LTS version is in your stack.yaml file.
  • For local documentation, use:
    • stack haddock --open to generate Haddock documentation for your dependencies, and open that documentation in a browser
    • stack hoogle <function, module or type signature> to generate a Hoogle database and search for your query
  • The Yesod cookbook has sample code for various needs

Getting Help