Go to file
Cathy Hu 60bd8fc56a [misc] Fix documentation github action 2020-09-12 19:28:32 +02:00
.github/workflows [misc] Fix documentation github action 2020-09-12 19:28:32 +02:00
git-hooks [misc] Tighten commit-msg hook 2020-07-11 02:02:40 +02:00
kibicara [core] Add fix secret as config option 2020-09-12 00:01:30 +02:00
kibicara-frontend [frontend] Fix unsubscribe error handling 2020-09-12 00:26:29 +02:00
tests [tests] Fix formatting 2020-09-12 18:42:52 +02:00
.editorconfig [misc] Add editorconfig 2020-07-02 14:29:59 +02:00
.gitignore [misc] Add PyCharm project files to gitignore 2020-07-05 19:39:38 +02:00
CONTRIBUTING.md [doc] Add platform bots acceptance criteria 2020-09-12 18:52:30 +02:00
COPYING [misc] Add maike to COPYING 2020-07-17 15:51:14 +02:00
DEPLOYMENT.md [doc] Add deployment docs and update contributing and readme docs 2020-09-11 19:45:44 +02:00
README.md [doc] Add status badges to README 2020-09-11 19:49:55 +02:00
package-lock.json [doc] Make test cycle a subpoint of backend 2020-09-06 20:44:58 +02:00
setup.py [email] Fix email bot 2020-07-17 15:51:14 +02:00
tox.ini [misc] Restrict pytest path to tests/ 2020-07-25 13:32:01 +02:00

README.md

Angular Frontend Python Backend

Kibicara

Kibicara relays messages between different platforms (= social networks).

In its web interface, a hood admin (= registered user) can create a hood to build a connection between different platforms.

Users can message a specific hood account on a specific platform (e.g. @xyz on Telegram). This pushes the announcement to all platform accounts of a hood. For example: User A writes a message to @xyz on Telegram (which has been connected to Kibicara by a hood admin). This publishes the message on e.g. Twitter and other platforms which have been connected to the hood.

The admin of a hood has to define trigger words and bad words. Messages need to contain a trigger word to be relayed, and must not contain a bad word.

Kibicara needs to be hosted on a server by an instance maintainer. That way, hood admins don't need a server of their own.

Deploy Kibicara on a production server

Read DEPLOYMENT.md to learn how to deploy Kibicara.

Contribute!

Read CONTRIBUTING.md to learn how to get started.