No description

Find a file

Oliver-Akins 3fc360054d Initial version of a proper README		2021-08-13 22:44:49 -06:00
docs	Remove the huge docs file and add alert that it isn't currently supported	2021-07-18 01:21:33 -06:00
src	Add the ability to have the tie alert go to a thread of the quote bracket message	2021-08-01 02:25:17 -06:00
.gitignore	Add all JSON files to the gitignore	2021-07-15 14:18:28 -06:00
config.template.toml	Add a template configuration	2021-08-13 22:44:34 -06:00
LICENSE	Initial commit	2020-04-18 19:31:05 -06:00
package-lock.json	Add Hapi's basic auth library	2021-07-23 11:48:07 -06:00
package.json	Add Hapi's basic auth library	2021-07-23 11:48:07 -06:00
quote-bracket.service	Change the service description to not reference Resonym directly	2021-08-13 21:59:46 -06:00
README.md	Initial version of a proper README	2021-08-13 22:44:49 -06:00
tsconfig.json	Specify that we only care about the src folder	2021-07-23 11:48:21 -06:00

README.md

Quote-Bracket

A system for determining the best quote for a stream. This was made for the Resonym community initially, but has since been expanded to allow the same system to run for multiple communities.

Installation Instructions:

Clone the git repo to a server
Setup your domain to point to the server, this can be pointing through a reverse proxy like Nginx or directly at the Node server. Note: However you set it up, it must support HTTPS, otherwise Discord will not let you use the domain as a webhook endpoint.
Copy config.template.toml to config.toml and fill it out with the required information.
Run npm install
Run tsc
Set the ExecStart and WorkingDirectory in the service file to run the equivalent of node dist/main.js. (the dist folder is generated by Typescript by transcompiling the code into Javascript)
Add the service file to your system's service folder.
Start the service

If you have any questions about the process feel free to open a GitHub Discussion