Social reading and reviewing, decentralized with ActivityPub, from upstream at https://github.com/bookwyrm-social/bookwyrm
 
 
 
 
 
 
Go to file
Dee 555c6dd7f7 nix: update changelog and pyproject version 2024-03-27 02:40:21 +01:00
.github CI: relax black version constraints 2024-03-20 12:46:37 +01:00
bookwyrm Merge tag 'v0.7.3' into nix 2024-03-27 01:16:46 +01:00
celerywyrm Merge tag 'v0.6.5' into nix 2023-08-20 17:42:53 +02:00
contrib Merge tag 'v0.7.1' into nix 2024-01-05 02:39:23 +01:00
dev-tools dev-tools: relax black version constraint 2024-03-21 16:25:29 +01:00
images Make sure /images/ and /static/ exist now that the bind mount is read only 2024-03-18 21:35:12 +01:00
locale Updates locales and adds missing trimmed on blocktrans 2024-03-25 16:13:00 -07:00
nginx Adds production.conf security configuration missing in version 0.7.2 2024-02-10 17:54:25 +09:00
nix nix: update changelog and pyproject version 2024-03-27 02:40:21 +01:00
postgres-docker Adjust sample postgres-docker cron file 2023-03-25 20:21:00 -04:00
static Make sure /images/ and /static/ exist now that the bind mount is read only 2024-03-18 21:35:12 +01: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 Enable Azure BlobStorage as an alternative to AWS S3 2023-03-05 12:08:16 -05:00
.editorconfig Add specific vendor file 2021-08-23 13:59:23 -07:00
.env.example Support DATA_UPLOAD_MAX_MEMORY_MiB, only, in .env 2024-02-04 15:34:04 -03: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 Merge tag 'v0.7.3' into nix 2024-03-27 01:16:46 +01:00
.prettierignore .prettierignore to vendor 2022-02-28 21:23:44 -08:00
.prettierrc Update .prettierrc 2023-10-17 19:49:32 +02:00
.pylintrc Adds line length and import-error to .pylintrc 2022-07-02 10:50:17 -07:00
CODE_OF_CONDUCT.md [lint] Fix indentation in .md files. 2021-03-04 19:05:01 +01:00
Dockerfile Merge tag 'v0.7.3' into nix 2024-03-27 01:16:46 +01:00
FEDERATION.md undo moves 2023-09-25 22:05:43 +10:00
LICENSE.md Rename License with a .md extension. 2021-04-28 16:05:12 +02:00
Makefile Using Poetry for dependency management and adjustments for docker 2021-04-03 13:39:53 -04:00
README.md Merge tag 'v0.5.3' into nix 2022-12-12 16:00:08 +01:00
SECURITY.md Create SECURITY.md 2022-06-30 05:46:41 +01:00
VERSION Bump version to 0.7.3. 2024-03-25 16:15:02 -07:00
bump-version.sh Bumped version number to 0.7.0 (#3052) 2023-10-21 18:29:45 +02:00
bw-dev Add Korean (ko-kr) to LANGUAGES and locale 2024-02-10 16:17:25 +09:00
complete_bwdev.fish Added mypy to scripts and workflow, and some first annotations for celerywyrm 2023-07-22 13:27:43 +02:00
complete_bwdev.sh Added mypy to scripts and workflow, and some first annotations for celerywyrm 2023-07-22 13:27:43 +02:00
complete_bwdev.zsh Added mypy to scripts and workflow, and some first annotations for celerywyrm 2023-07-22 13:27:43 +02:00
crowdin.yml Update Crowdin configuration file 2021-10-06 21:50:47 -07:00
docker-compose.yml Merge branch 'main' into production 2024-03-25 16:11:26 -07:00
flake.lock nix: update flake lock 2024-03-27 01:25:18 +01:00
flake.nix nix: update flake description 2023-12-02 19:49:12 +01:00
manage.py Updates migrations 2020-09-21 08:10:37 -07:00
mypy.ini Merge branch 'main' into mypy-utils 2023-09-08 08:53:38 +02:00
poetry.lock Merge tag 'v0.7.3' into nix 2024-03-27 01:16:46 +01:00
pyproject.toml nix: update changelog and pyproject version 2024-03-27 02:40:21 +01:00
pytest.ini pytest.ini: define ALLOWED_HOSTS 2024-03-11 20:12:46 +01:00
redis.conf Add redis automatic rewrite configuration. 2024-01-23 18:19:31 -05:00

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.