Go to file
missytake 51929f8071 [doc] Fix ending of a file in CONTRIBUTING.md 2023-04-09 10:31:07 +00:00
.github/workflows [misc] Fix documentation github action 2020-09-12 19:28:32 +02:00
backend [mastodon] Dismiss old notifications in the migration script, so they aren't reposted by ticketfrei3 2023-04-08 16:53:21 +00:00
frontend [frontend] Add initial mastodon frontend 2023-03-19 18:36:15 +01:00
git-hooks [misc] Move things to the right place 2023-03-18 16:48:59 +01: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] Fix ending of a file in CONTRIBUTING.md 2023-04-09 10:31:07 +00:00
COPYING [core] Don't read configs at the module top-level 2023-03-18 18:18:44 +01:00
DEPLOYMENT.md fixed typos 2021-12-06 16:17:18 +01:00
README.md [doc] Add status badges to README 2020-09-11 19:49:55 +02:00
setup.sh [tests] Disable trio backend for AnyIO 2023-04-01 14:40:02 +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.