Stuce/sTodo
1
0
Fork 0
Code Issues Pull requests Projects Releases 3 Packages Wiki Activity Actions
sTodo/README.md
stuce 3511f257e6 Update README.md
2025-06-27 13:43:56 +02:00

2.9 KiB
Raw Blame History

sTodo

Stuce's simple todo is a web app that let's you self host a simple todolist. The goal is to provide a minimalistic and fast todo list that is self hostable.

Next goals

  • Make multi user support
    • Get user by trusted header
    • Add menu to add other users to the group
    • make the code more readable by renaming/moving the handlers better
    • write a minimal step by step guide to install with nix,
    • add some css to make it look nicer
    • add htmx to make more agreable without making js manadatory

Version 0.0.0

Simple todo list for single user only at the moment. Features : - add and delete (and soon share) groups that contain a list of todolists - add and delete todolists inside groups - add todolist items or edit complete list via text for easy manipulation - possibility to deploy easily via nix module with a flake - that's it, the goal is to keep it minimal !!!

Haskell Setup (I sadly don't use nix develop at the moment)

  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 sTodo:library-only --flag sTodo: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