sheerluck

README

sheerluck

AI-powered murder mystery game

Quickstart

TailwindCSS

Standalone executable

This project uses tailwindcss. You can use it without setting up Node.js using standalone executables.

Download latest tailwindcss executable for your platform.

Start watching for changes in the templates. This generates ui/static/main.css loaded at every page.

./tailwindcss -i input.css -o ui/static/main.css --watch

Jetbrains autocomplete for TailwindCSS and prettier class sorter

Unfortunately, Jetbrains Tailwind CSS plugin may not support the standalone Tailwind executable. To get around this, you have to initialize the NodeJs project and maybe restart the IDE.

nvm use
pnpm i

Generate templ code

This project uses Templ for the HTML templates.

When you do changes to the .templ files, you need to run the following:

templ generate

Start go server

Make sure you're using the go version configured in go.mod. To start the server, run the following:

go run ./cmd/web/

Navigate to http://localhost:3003 to see the service in action.

Attribution

Sheerluck logo made by Martin Yrjölä.

Images was created with the assistance of DALL·E 2.

HeroIcons made by steveschoger. Available on https://heroicons.dev/.

Game Icons made by Delapouite and Skoll. Available on https://game-icons.net.