Thanks to visit codestin.com
Credit goes to github.com

Skip to content

pandorasNox/lettr

Repository files navigation

Project build, test and lint status badge

lettr

Disclaimer

With regard to support, the maintainers of this repository are not obligated to provide assistance and likely never will. If you have received support in the past, consider it a rare and unlikely-to-be-repeated stroke of luck. For modifications, enhancements, or custom support, you are encouraged to fork the repository and make the necessary changes independently. Contributions via merge or pull requests are welcome, but please be aware that there is no guarantee they will be reviewed or merged. Treat this project as though it is effectively archived, even if it has not been officially labeled as such. While any contributions you make are appreciated, please lower and manage your expectations and keep them modest.

known issues

  • If server restarts while playing, the next guess will end in a "fake rows" error. Resolved by reloading the page.

plan of action

  • generate session (cookie) when none is present
  • keep user data in server memory
  • optional: session memory management based on cookie lifetime

quiz

what happens on server side

open todo

  • must
    • word not InWordDB
    • website app version via ??? (assets? or on webpage?)
    • (mobile) keyboard (use + indication for used letters)
    • protect against request size + correct http 413 error code throw
    • fix scripts/tools.sh func_exec_cli passing parameter issue
    • bugfix: full page get form submit request on random occations when it should just be a htmx post
    • avoid same word twice (words to exclude (previous taken quizes))
    • editorial work: e.g. words like games or gamer are missing + maybe we introduce a common vs uncommen word list
    • fix past words display
    • add github action ci pipeline build + tests
      • build
      • tests
      • linting
      • test image build
      • formatting
    • add imprint/link to imprint
    • fix letter hints is not reset with new game bug
    • add metrics endpoint
    • add scheduled RemoveExpiredSessions func (go routine in main.go)
    • tailwind check build succes (with files)
    • os.SIGNAL handling (gracefull server Shutdown)
    • self include unpack htmx javascript lib
      • reasons:
        • supply chain security
          • don't trust external script sources, even so they are very very well known
          • best example was the polyfill incident
          • also: htmx repo probbably should be forked + synced with upstream
            • add renovate
        • much more clean & professional to own it + allows customizations
    • add shellcheck to ci pipeline & local setup
    • ESLint
    • decide if we want to use htmx response extension vs htmx oob-swat core + custom js code
      • note: we want philosopical correct http error codes
      • atm we use both => quesion should we only use one, when, which one, when not, why both + wrote adr (decision record)
    • "someone" does not trust our tests, and with this bulletpoint solved would
      • include browser based e2e tests e.g. playwright/cypress
      • api tests?
      • load tests?
      • more unit tests?
      • more integration tests? (e.g. go's testserver based tests)
    • renoevate: for docker images add compatibility / build versioing to also update alpine version
  • nice-to-have (e.g. node & golang)

About

Word guessing game using letters

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •