jbrechtel/roux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Elaborates more of the project description

Browse Source
This commit is contained in:
James Brechtel
2026-05-18 21:44:55 -04:00
parent aeb032209c
commit 321df6badc
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.org
+8 -1
View File
@@ -13,11 +13,18 @@ Roux uses Cooklang (https://cooklang.org/) as a source of truth for all recipe c
*** Cook history *** Cook history
Roux lets you track when you cook recipes. I like this because we cook a lot of different recipes and I like to be able to go back to find things I liked in the past so I don't forget about them. Roux lets you track when you cook recipes. I like this because we cook a lot of different recipes and I like to be able to go back to find things I liked in the past so I don't forget about them.
** Tech stack ** Technical details
*** Development environment
Docker is used for all development tools. Nothing is required to be installed on the local machine except Docker.
*** Backend API: Haskell + SQLite *** Backend API: Haskell + SQLite
*** Frontend: Static HTML + Pico CSS *** Frontend: Static HTML + Pico CSS
The actual backing for recipes themselves is a single cooklang directory with The actual backing for recipes themselves is a single cooklang directory with
an in-process search index that gets rebuilt whenever a file is added to the an in-process search index that gets rebuilt whenever a file is added to the
directory. directory.
*** Project structure:
**** cooklang-hs
A Cooklang parser written in Haskell.
**** roux-server
The webserver for Roux. Parses Cooklang files on disk, indexes them, renders HTML templates for presenting recipes.