Holmes

A simplistic powerful template / starter kit for making your own cryptic / scavenger hunts written completely in Golang and templ

Features

• No javascript *
• Very easy to extend
• Built in admin panel to manage users, questions and hints
• Adding images, videos and audios to questions
• Built in authentication system
• Built in rate limiting
• Built in leaderboard
• Easy to add custom routes

* (Except for the tailwind stuff and toggling the navbar)

Run Locally

• Clone the project

  git clone https://github.com/namishh/holmes

• Go to the project directory

  cd holmes

• Install go dependencies

  # air for live reload
  go install github.com/air-verse/air@latest
  # templ
  go install github.com/a-h/templ/cmd/templ@latest

• Install npm dependencies for tailwind

  npm i

• Fill in the .env file

DB_NAME="database.db"
SECRET=""
ADMIN_PASS="holmes"
ENVIRONMENT="DEV"
BUCKET_NAME="xxx"
BUCKET_ENDPOINT="xxx.xx.xxx"
BUCKET_ACCESSKEY="xxx-xxxxxxxxxxxxxxx"
BUCKET_SECRETKEY="xxxxxxxxxxxxx"

• Start the server

  ## start templ
  make templ

  ## start tailwind watcher
  make css

  ## run the server
  export ENVIRONMENT="DEV" ; make dev

• To build the project

  make build

Screenshots

• Home Page

• Auth Pages

• Admin Panel

• All the questions

• Questions

• Hints

• Single Question

• Opened Hint

• Leaderboard

• Error Pages

Todo

• Setup the project
• Auth
  • Login and Register
  • Logout
• Admin
  • Delete User
  • Add Question
  • Delete Question
  • Edit Question
    • Edit Details
    • Edit Media
  • Hints
    • Add hint
    • Delete hint
• Game flow
  • Get all questions
  • Get Question
  • Submit Answer
  • Update Score
  • Get Hint
  • End Game
• Leaderboard
• Error Pages
• Rate limiting
• Hosted on Zerops

Acknowledgements

• emarifer/go-echo-templ-htmx
• zerops for the cheap af hosting and object storage.