{"id":28185467,"url":"https://github.com/hmaier-dev/checklist-tool","last_synced_at":"2026-04-13T04:02:50.778Z","repository":{"id":292010794,"uuid":"937537432","full_name":"hmaier-dev/checklist-tool","owner":"hmaier-dev","description":"web-app to work down yaml-based checklists","archived":false,"fork":false,"pushed_at":"2025-12-02T19:38:41.000Z","size":750,"stargazers_count":0,"open_issues_count":8,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-03T04:39:05.558Z","etag":null,"topics":["golang","htmx","sqlite","yaml"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hmaier-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-02-23T09:59:01.000Z","updated_at":"2025-12-02T19:38:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"fe1860fb-2907-459d-a521-d2e0d39fe63d","html_url":"https://github.com/hmaier-dev/checklist-tool","commit_stats":null,"previous_names":["hmaier-dev/checklist-tool"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/hmaier-dev/checklist-tool","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmaier-dev%2Fchecklist-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmaier-dev%2Fchecklist-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmaier-dev%2Fchecklist-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmaier-dev%2Fchecklist-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hmaier-dev","download_url":"https://codeload.github.com/hmaier-dev/checklist-tool/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmaier-dev%2Fchecklist-tool/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31739050,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T03:27:07.512Z","status":"ssl_error","status_checked_at":"2026-04-13T03:26:53.610Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["golang","htmx","sqlite","yaml"],"created_at":"2025-05-16T06:12:06.901Z","updated_at":"2026-04-13T04:02:50.760Z","avatar_url":"https://github.com/hmaier-dev.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e[!NOTE]\n\u003e Go find the the tool on https://codeberg.org/schnelles_geraet/checklist-tool\n## Development\nTo simplifly development on Windows and Linux [`earthly`](https://docs.earthly.dev/) is used to build the project.\n```cmd\nearthly +run --tag=\"test\"\n```\nThe outputs a image called `ghcr.io/hmaier-dev/checklist-tool:test`. Run this image by using the compose stack.\n```cmd\nearthly +run --tag=\"test\" \u0026\u0026 docker compose up\n```\nA example compose stack is within the root of the project.\n\nUse this command to run it raw without `earthly`\n```bash\ngo build -x -v -p 4 -o ./bin/cltool main.go \u0026\u0026 tailwindcss -i ./static/base.css -o ./static/style.css \u0026\u0026 ./bin/cltool -db=sqlite.db\n```\n### SQL\nAll changes to the database schema/queries are done in the sql-files in root (`schema.sql` and `query.sql`). After making changes, you need to run\n```bash\nsqlc generate\n```\nfrom the project-root which contains the config file `sqlc.yml`.\n\u003e[!WARNING]\n\u003e Please beware that `sqlc` does not run any migrations. You can break existing databases by adjusting your schema.\n\n## Deployment\nA example `compose.yml` can be found under the root of this project.\n### gotenberg\nThe gotenberg-Container is used for the creation of pdfs.\nThe checklist-tool can be run without gotenberg, but will throw an error when a checklist gets exported: https://github.com/hmaier-dev/checklist-tool/blob/66159b446c2180e9c846cbad91a53904368872d5/internal/pdf/pdf.go#L13\n\n## Checklist\nThis app uses `yaml` store the checklist itself and a preceding frontmatter to store all meta-data.\n\nA checklist can look like this:\n```yaml\n---\nname: auf arbeit gehen\nfields: [fullname,ticket,typ]\ndesc: [\"Nachname, Vorname\",\"Ticket Number\",\"Modell\"]\ntab_desc_schema: [fullname,typ]\npdf_name_schema: [date,fullname,typ]\n---\n\n- task: \"Auf Arbeit kommen.\"\n  checked: false\n  text: \"Setze diesen Schlüssel, um ein Textfeld anzuzeigen.\"\n  children:\n  - task: \"Kaffee trinken.\"\n    checked: false\n- task: \"Tickets bearbeiten.\"\n  checked: false\n```\n### Frontmatter\nIs the place where all the meta-data is stored.\n\n| Key | Data  |\n| --- | --- |\n| fields | Takes a list of keys, which will store user input (need to be the same length as `desc`). E.g. `fields[2] == desc[2]` |\n| desc | Takes a list of quoted strings, which function as labels for the input fields  (need to be the same length as `fields`) E.g. `desc[1] == fields[1]`|\n| tab_desc_schema | Defines the browser-tab-description-schema. Use the `fields` seperated by `,`. Values will be display separated by `\\|` |\n| pdf_name_schema | Defines how the pdf will be named. Use the `fields` seperated by `,`. Values will be display separated by `_`. **An extra field is `date` (only available in this key)** which displays the current date when exporting in `yyyyMMdd`-format. |\n\n### Yaml\n\n\u003e[!NOTE]\n\u003e Note that, the `task`-string is used as an identifier and cannot be used twice!\n\n## Motivation\nAt work I'm dealing with mobile devices, whose setup require multiple steps I need to keep track of. This is not just for me but also for quality assurance.\nWorking with/in PDFs is tireseome in serveral ways. So I decided to write this small project, which should ease my time setup up the devices.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmaier-dev%2Fchecklist-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhmaier-dev%2Fchecklist-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmaier-dev%2Fchecklist-tool/lists"}