Social reading and reviewing, decentralized with ActivityPub, from upstream at https://github.com/bookwyrm-social/bookwyrm
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Dee 1ecdf245d2 Fix broker Redis connections over unix sockets 2 months ago
.github Add HTTP_X_FORWARDED_PROTO:false to Test 3 months ago
bookwyrm Fix broker Redis connections over unix sockets 2 months ago
celerywyrm Fix broker Redis connections over unix sockets 2 months ago
dev-tools Updates node to version 18 6 months ago
locale Updates locales 2 months ago
nginx nginx: route /flower to the queue monitoring system. 2 months ago
nix nix: use separate redises, and talk to them over sockets 2 months ago
postgres-docker Add database to filename, don't install recommends 1 year ago
updates Adds celerybeat update script 11 months ago
.coveragerc [lint] Fix missing new lines. 2 years ago
.dockerignore [lint] Fix missing new lines. 2 years ago
.editorconfig Add specific vendor file 1 year ago
.env.example Apologies for my lack of coding skills 3 months ago
.eslintignore [assets] Move some frontend assets to _vendor_ directories: 2 years ago
.eslintrc.js [assets] Document functions and variables: 2 years ago
.gitignore Merge branch 'production' into nix 10 months ago
.prettierignore .prettierignore to vendor 11 months ago
.pylintrc Adds line length and import-error to .pylintrc 7 months ago
CODE_OF_CONDUCT.md [lint] Fix indentation in .md files. 2 years ago
Dockerfile Merge tag 'v0.4.4' into nix 6 months ago
LICENSE.md Rename License with a .md extension. 2 years ago
Makefile Using Poetry for dependency management and adjustments for docker 2 years ago
README.md Merge tag 'v0.5.3' into nix 2 months ago
SECURITY.md Create SECURITY.md 7 months ago
bw-dev Manual email confirm (#2492) 2 months ago
complete_bwdev.fish Manual email confirm (#2492) 2 months ago
complete_bwdev.sh Manual email confirm (#2492) 2 months ago
complete_bwdev.zsh Manual email confirm (#2492) 2 months ago
crowdin.yml Update Crowdin configuration file 1 year ago
docker-compose.yml Merge branch 'main' into production 2 months ago
flake.lock nix: update flake 6 months ago
flake.nix nix: add flake 2 years ago
manage.py Updates migrations 2 years ago
poetry.lock Merge tag 'v0.5.3' into nix 2 months ago
pyproject.toml Merge tag 'v0.5.3' into nix 2 months ago
pytest.ini Updates tests env 1 year ago
redis.conf Use redis with password in dev 1 year ago
update.sh Adds missing update script 11 months ago

README.md

BookWyrm

Note: This branch is a fork of upstream Bookwyrm adapted to run on NixOS (outside of Docker). For more details on this, see nix/README.md The rest of this document is the upstream README.


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.