scribe

command module
v0.0.0-...-481badc Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 25, 2025 License: MIT Imports: 7 Imported by: 0

README

Scribe

Discord bot for recording & recalling quotes

Setup

  • Install Go 1.24 or above
  • Install the Tailwind CLI.
    • Ensure the tailwindcss command is accessible from $PATH.
    • If you have homebrew installed, use: brew install tailwindcss.
Setup the config
cp .env.dist .env

Create an application on https://discord.com/developers/applications/ and fill out at least the SCRIBE_TOKEN, SCRIBE_GUILD_ID, and SCRIBE_APP_ID fields in .env

Running the app

Just run air

go tool air

Production data

If you'd like to have the production data to play around with,

  • Use /db in the server you are in with Scribe.
  • Download the quotes.sqlite file.
  • Move that file to your SQLITE_DB_PATH location, the default is the root of the project directory.

Website

To develop the website, you'll need to ensure its setup to let you log into it using Discord OAuth2

  • Head to OAuth2, grab your client id & secret, set them up in your .env.
  • Set SCRIBE_COOKIE_SECRET in .env to be a random value of your choice.
  • Setup a callback URL, both in your bot's OAuth2 tab, and your .env file

Then, head to http://localhost:8000/, you should be able to log in, and view the web UI.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg
bot
web
web/ui
templ: version: v0.3.906
templ: version: v0.3.906
web/ui/components
templ: version: v0.3.906
templ: version: v0.3.906
web/ui/pages
templ: version: v0.3.906
templ: version: v0.3.906

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL