Add readme
This commit is contained in:
parent
07651ae4a7
commit
83d737c92e
|
@ -0,0 +1,14 @@
|
|||
# rqlite URL
|
||||
DATABASE_URL=http://rqlite:4001
|
||||
|
||||
# message queue URL
|
||||
MQ_URL=tcp://mq:9000
|
||||
|
||||
# discord bot token
|
||||
TOKEN=
|
||||
|
||||
# discord channel to post new XKCD comics to
|
||||
UPLOAD_CHANNEL=
|
||||
|
||||
# zipkin url to report spans
|
||||
ZIPKIN_URL=http://zipkin:9411/api/v1/spans
|
|
@ -0,0 +1,35 @@
|
|||
# vyvanse
|
||||
|
||||
A simple chatbot and spamfiltering automaton for your discord enjoyment. Click this link to
|
||||
[invite me to your server](https://discordapp.com/oauth2/authorize?client_id=266986250689445888&scope=bot)!
|
||||
|
||||
## Stack
|
||||
|
||||
- Go
|
||||
- Discordgo
|
||||
- Drone MQ
|
||||
- RQLite
|
||||
- Zipkin
|
||||
|
||||
## Local Development
|
||||
|
||||
### Dependencies
|
||||
|
||||
- [box](https://github.com/box-builder/box)
|
||||
- [Nim](https://nim-lang.org)
|
||||
- [Docker](https://docker.com) (either the toolbox or the native app will work)
|
||||
|
||||
### Setup
|
||||
|
||||
```console
|
||||
$ cp .env.sample .env
|
||||
$ e .env # or your favorite editor
|
||||
```
|
||||
|
||||
Fill out `TOKEN=` with your discord bot token.
|
||||
|
||||
```console
|
||||
$ nim up
|
||||
```
|
||||
|
||||
Then head to [Zipkin](http://127.0.0.1:9411) and see the tracing data for each command invocation.
|
Loading…
Reference in New Issue