Felix Ableitner
1d6855bdc4
|
||
|---|---|---|
| assets | ||
| config | ||
| migrations | ||
| scripts | ||
| src | ||
| tests | ||
| .gitignore | ||
| .rustfmt.toml | ||
| .woodpecker.yml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| LICENSE | ||
| README.md | ||
| Trunk.toml | ||
| build.rs | ||
| config.toml | ||
| diesel.toml | ||
README.md
Ibis - A federated Wikipedia Alternative
A federated Wikipedia alternative. Main objects in terms of federation are the Instance and Article. Each article belongs to a single origin instance, the one where it was originally created. Articles have a collection of Edits a custom ActivityPub type containing a diff. The text of any article can be built by starting from empty string and applying all associated edits in order. Instances can synchronize their articles with each other, and follow each other to receive updates about articles. Edits are done with diffs which are generated on the backend, and allow for conflict resolution similar to git. Editing also works over federation. In this case an activity Update/Edit is sent to the origin instance. If the diff applies cleanly, the origin instance sends the new text in an Update/Article activity to its followers. In case there is a conflict, a Reject activity is sent back, the editor needs to resolve and resubmit the edit.
Useful links
Name
The Ibis is a bird which is related to the Egyptian god of knowledge and science.
Development
First install PostgreSQL and setup the development database:
psql -c "CREATE USER ibis WITH PASSWORD 'ibis' SUPERUSER;" -U postgres
psql -c "CREATE DATABASE ibis WITH OWNER ibis;" -U postgres
You need to install cargo, trunk and cargo watch. Run ./scripts/watch.sh which automatically rebuilds the project after changes. Then open the site at 127.0.0.1:8080.
By default the frontend runs on port 8080, which can be changed with env var TRUNK_SERVE_PORT. The backend port is 8081 and can be changed with IBIS_BACKEND_PORT.