Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/the-programmers-hangout/nano
Forked from https://gitlab.com/tphelliott/nano
https://github.com/the-programmers-hangout/nano
Last synced: about 14 hours ago
JSON representation
Forked from https://gitlab.com/tphelliott/nano
- Host: GitHub
- URL: https://github.com/the-programmers-hangout/nano
- Owner: the-programmers-hangout
- License: mit
- Created: 2020-03-29T16:00:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-25T11:15:17.000Z (over 3 years ago)
- Last Synced: 2023-03-03T07:59:28.325Z (over 1 year ago)
- Language: Kotlin
- Homepage:
- Size: 150 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nano - A Minimalistic Q&A Bot.
Nano is a community bot for running live AMA's. Interviews can be started with a target user and members of the community can ask questions. These questions are filtered by staff, and then answered by the interviewee in a DM with the bot.
#### Participant Experience
Interview participants can ask questions in the configured channel, using the prefix you've chosen for questions. Once a question is submitted, it goes into a moderation queue channel for review.
**Asking Questions**
![Asking Questions](https://i.imgur.com/V4gjsEA.png)
If the question gets approved by the moderation team, it gets added to the interviewee's question queue. Participants can view answers to questions in the answer channel that gets auto-generated for that interview.
**Viewing Answers**
![Viewing Answers](https://i.imgur.com/PVpUOpu.png)
#### Interviewee Experience
Once the interview is started the interviewee will receive a private message from the bot explaining how to answer questions. They can then answer them directly in the DM.
**Answering Questions**
![Answer Questions](https://i.imgur.com/CqW9AZh.png)
#### Moderation Experience
Whichever channel you specify as the moderation queue will receive the questions that users ask and give you the opportunity to approve or reject a question. It's purely based on which reaction happens to the message first at this point. Once approved, it goes into the interviewee's queue for answering. If an interviewee doesn't want to answer the questions they can simply use the `next` command to skip it.
![Moderation Queue](https://i.imgur.com/LlUfjh9.png)
## Commands
Refer to [commands.md](commands.md) for a general list and explanation of all available commands. To learn about commands during runtime, use the `help` command!
## Setup Guide
Since this is such a special purpose bot, I may never get around to writing a setup guide. At this point, whenever it comes to running it, you're completely on your own. Do not DM me and ask for help. It's extremely simple to get going and you can reference other KUtils projects for examples on how to go about it.