Social reading and reviewing, decentralized with ActivityPub
Find a file
2022-11-26 11:33:16 -08:00
.github Add HTTP_X_FORWARDED_PROTO:false to Test 2022-11-19 18:02:34 +01:00
bookwyrm registration answer was not long enough client side, fixes #2377 for real 2022-11-26 11:33:16 -08:00
celerywyrm Adds auto-create queues option to config 2022-03-17 09:57:25 -07:00
dev-tools Updates node to version 18 2022-07-26 15:07:40 -07:00
locale Updates locales 2022-11-25 08:32:10 -08:00
nginx Fixes rate limiter 2022-11-01 18:17:37 -07:00
updates Adds celerybeat update script 2022-03-16 12:53:27 -07:00
.coveragerc [lint] Fix missing new lines. 2021-03-04 18:44:36 +01:00
.dockerignore [lint] Fix missing new lines. 2021-03-04 18:44:36 +01:00
.editorconfig Add specific vendor file 2021-08-23 13:59:23 -07:00
.env.example Apologies for my lack of coding skills 2022-11-20 17:57:03 +01:00
.eslintignore [assets] Move some frontend assets to _vendor_ directories: 2021-04-05 16:17:11 +02:00
.eslintrc.js [assets] Document functions and variables: 2021-04-06 16:17:20 +02:00
.gitignore Updates .gitignore for themes 2022-02-28 09:37:51 -08:00
.prettierignore .prettierignore to vendor 2022-02-28 21:23:44 -08:00
.pylintrc Adds line length and import-error to .pylintrc 2022-07-02 10:50:17 -07:00
bw-dev Remove TFA from user 2022-11-15 23:20:21 +01:00
CODE_OF_CONDUCT.md [lint] Fix indentation in .md files. 2021-03-04 19:05:01 +01:00
complete_bwdev.fish Adds a couple tests to annual review views 2022-09-19 14:38:30 -07:00
complete_bwdev.sh Adds a couple tests to annual review views 2022-09-19 14:38:30 -07:00
complete_bwdev.zsh Adds a couple tests to annual review views 2022-09-19 14:38:30 -07:00
crowdin.yml Update Crowdin configuration file 2021-10-06 21:50:47 -07:00
docker-compose.yml Quote ports in docker-compose 2022-11-16 12:38:49 +01:00
Dockerfile Go back to one requirements.txt, simplify workflow 2022-06-05 14:57:42 -07:00
LICENSE.md Rename License with a .md extension. 2021-04-28 16:05:12 +02:00
manage.py Updates migrations 2020-09-21 08:10:37 -07:00
pytest.ini Updates tests env 2022-01-09 12:04:45 -08:00
README.md Fix Quick Typo 2022-11-18 23:24:18 -08:00
redis.conf Use redis with password in dev 2022-01-05 08:52:28 -08:00
requirements.txt Bump django from 3.2.15 to 3.2.16 2022-10-21 03:40:27 +00:00
SECURITY.md Create SECURITY.md 2022-06-30 05:46:41 +01:00
update.sh Adds missing update script 2022-03-16 13:32:37 -07:00

BookWyrm

Run Python Tests Pylint

BookWyrm is a social network for tracking your reading, talking about books, writing reviews, and discovering what to read next. Federation allows BookWyrm users to join small, trusted communities that can connect with one another, and with other ActivityPub services like Mastodon and Pleroma.

Mastodon Follow Twitter Follow

About BookWyrm

BookWyrm is a platform for social reading. You can use it to track what you're reading, review books, and follow your friends. It isn't primarily meant for cataloguing or as a data-source for books, but it does do both of those things to some degree.

Federation

BookWyrm is built on ActivityPub. With ActivityPub, it inter-operates with different instances of BookWyrm, and other ActivityPub compliant services, like Mastodon. This means you can run an instance for your book club, and still follow your friend who posts on a server devoted to 20th century Russian speculative fiction. It also means that your friend on mastodon can read and comment on a book review that you post on your BookWyrm instance.

Federation makes it possible to have small, self-determining communities, in contrast to the monolithic service you find on GoodReads or Twitter. An instance can be focused on a particular interest, be just for a group of friends, or anything else that brings people together. Each community can choose which other instances they want to federate with, and moderate and run their community autonomously. Check out https://runyourown.social/ to get a sense of the philosophy and logistics behind small, high-trust social networks.

Features

Post about books

Compose reviews, comment on what you're reading, and post quotes from books. You can converse with other BookWyrm users across the network about what they're reading.

Track reading activity

Keep track of what books you've read, and what books you'd like to read in the future.

Federation with ActivityPub

Federation allows you to interact with users on other instances and services, and also shares metadata about books and authors, which collaboratively builds a decentralized database of books.

Privacy and moderation

Users and administrators can control who can see their posts and what other instances to federate with.

Tech Stack

Web backend

Front end

  • Django templates
  • Bulma.io css framework
  • Vanilla JavaScript, in moderation

Deployment

Set up BookWyrm

The documentation website has instruction on how to set up BookWyrm in a developer environment or production.