berry

module
Version: v0.0.0-...-2970e9b Latest Latest
Warning

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

Go to latest
Published: Feb 19, 2021 License: AGPL-3.0

README

Berry

Berry is a searchable glossary bot for Discord.

Requirements

  • PostgreSQL (only 12.5 tested)
  • Go (only 1.15 tested)
  • For the site and API: a reverse proxy (such as Caddy or nginx)

Running

This is still very much a WIP. Although we've done our best to not hardcode names and links into the source code, they still show up in some places (notably the site), so we recommend going through the source and fixing all those references before you run it.

Bot
  1. go build in the root directory
  2. Copy config.sample.json to config.json and fill it in
  3. Run the executable

Note: The database is managed by the bot executable, you'll have to run that at least once even if you don't plan on running a bot.

API
  1. go build in the api/ directory
  2. Copy config.sample.yaml to confi.yaml and fill it in
  3. Run the executable
Site
  1. go build in the site/ directory
  2. Copy config.sample.yaml to confi.yaml and fill it in
  3. Run the executable

License

Copyright (C) 2020, Starshine System

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Directories

Path Synopsis
Package bot contains the bot's core functionality.
Package bot contains the bot's core functionality.
cmd
api
bot
export
Package main is a simple utility to export a Berry/Termora database
Package main is a simple utility to export a Berry/Termora database
commands

Jump to

Keyboard shortcuts

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