/yesod-money-manager

A web application for managing money.

Primary LanguageHaskellGNU General Public License v3.0GPL-3.0

Status

The intent of this project is to build a non-trivial web application using Haskell. At the moment, the project provides none of its intended functionality.

Database Setup

After installing Postgres, run:

createuser yesod-money-manager --password yesod-money-manager --superuser
createdb yesod-money-manager
createdb yesod-money-manager_test

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 be recompiled and redeployed to localhost.

Tests

stack test --flag yesod-money-manager:library-only --flag yesod-money-manager: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