1
0
Fork 0
Fork of https://github.com/bookwyrm-social/bookwyrm for NixOS deployment
Find a file
2025-03-13 14:56:30 +01:00
bookwyrm Introduce 'MEDIA_ROOT_ABS' environment variable 2025-03-13 14:56:30 +01:00
celerywyrm Remove telemetry, Docker, Github-specifics, development-only tools 2025-03-10 18:33:17 +01:00
dev-tools Remove telemetry, Docker, Github-specifics, development-only tools 2025-03-10 18:33:17 +01:00
exports Add exports_volume to docker-compose.yml 2024-03-24 12:08: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 Fixes inconsistent wording in source text 2024-10-17 14:56:20 -07:00
static Make sure /images/ and /static/ exist now that the bind mount is read only 2024-03-18 21:35:12 +01:00
.coveragerc [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 Allow serving BookWyrm on a non-standard port 2024-04-24 15:30:47 +02:00
.gitignore Add docker-compose.override.yml to .gitignore 2024-04-15 13:17:00 +02:00
.pylintrc pylint: enable useless-suppression lint and perform cleanup 2024-07-27 03:47:35 -03:00
bump-version.sh Bumped version number to 0.7.0 (#3052) 2023-10-21 18:29:45 +02:00
CODE_OF_CONDUCT.md [lint] Fix indentation in .md files. 2021-03-04 19:05:01 +01:00
crowdin.yml Update Crowdin configuration file 2021-10-06 21:50:47 -07: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
manage.py Updates migrations 2020-09-21 08:10:37 -07:00
pytest.ini Use in-memory backends for Celery in tests and workflows 2024-07-28 06:42:11 -03:00
README.md Remove twitter from README.md 2024-03-26 17:14:09 +00:00
redis.conf Add redis automatic rewrite configuration. 2024-01-23 18:19:31 -05:00
requirements.txt Bump django from 4.2.17 to 4.2.18 2025-02-14 03:14:17 +00: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

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

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.