A discord bot for natural language surveys, inspired by and in the style of talk to the city.

Join the discord server for discussing and developing this tool here.

1. Create a .env file with the following variables:

   DISCORD_TOKEN=
   OPENAI_API_KEY=
   REDIS_URL=
   CLIENT_ID=
   GUILD_ID=
   SUMMARIZE_FREQUENCY_SECONDS=3600

2. Run npm install

3. Start redis with redis-server

4. Start the main bot script with npm run bot

5. Start the gpt summarization script with npm run summarizer

docker build -t <your-image-name>:<your-image-tag> .

The image has two operational modes: bot by default and summarizer

To run the bot use the bot argument and to run the summarizer use summarizer.

docker run -it -d --env-file ./.env <your-image-name>:<your-image-tag> bot

The --env-file flag takes a filename as an argument and expects each line to be in the VAR=VAL format, mimicking the argument passed to --env. Comment lines need only be prefixed with #

docker-compose up --build

TODO

To make a contribution do the following steps:

1. Make an issue that includes a user story for what the user should be able to do (eg user should be able to view the survey summary in their local language).
2. Get that issue approved by the product owners (for now just me / Evan / es92).
3. Write a PR and get that approved by the code owners (for now also just me / Evan / es92). Each PR must correspond to an approved issue. By default PRs should be merged by the PR submitter, though in some cases if changes are needed they can be merged by code owners.