Social Cinema/TV and reviewing, decentralized with ActivityPub
Go to file
Mouse Reeve e3471fcc35
Merge pull request #2148 from hughrun/quotes
add page numbers to comment and quote statuses
2022-06-10 17:35:15 -07:00
.github Go back to one requirements.txt, simplify workflow 2022-06-05 14:57:42 -07:00
bookwyrm Merge pull request #2148 from hughrun/quotes 2022-06-10 17:35:15 -07:00
celerywyrm Adds auto-create queues option to config 2022-03-17 09:57:25 -07:00
dev-tools Updates black version 2022-05-23 12:46:45 -07:00
locale Updates locales for stopped reading strings 2022-05-31 16:53:46 -07:00
nginx Comment out trailing block ending 2021-12-01 14:18:28 +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 [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 Removes inline comments that are causing erros 2022-02-18 21:07:39 -08: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 Add .pylintrc with fixes for new pylint version 2022-06-05 14:38:03 -07:00
CODE_OF_CONDUCT.md [lint] Fix indentation in .md files. 2021-03-04 19:05:01 +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
README.md docs: Fix broken links in README 2022-05-15 13:01:25 +02:00
bw-dev Add pylint to bw-dev 2022-06-05 14:49:21 -07:00
complete_bwdev.fish remove no-up autocomplete 2022-03-12 04:38:42 -08:00
complete_bwdev.sh Adds zsh-specific completions file 2022-04-04 15:17:18 -07:00
complete_bwdev.zsh Adds zsh-specific completions file 2022-04-04 15:17:18 -07:00
crowdin.yml Update Crowdin configuration file 2021-10-06 21:50:47 -07:00
docker-compose.yml add automatic restart of containers 2022-05-09 11:00:28 +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
redis.conf Use redis with password in dev 2022-01-05 08:52:28 -08:00
requirements.txt Merge pull request #2150 from cincodenada/fix-pylint 2022-06-05 15:41:32 -07:00
update.sh Adds missing update script 2022-03-16 13:32:37 -07:00

README.md

BookWyrm

Social reading and reviewing, decentralized with ActivityPub

Contents

Joining BookWyrm

If you'd like to join an instance, you can check out the instances list.

Contributing

See contributing for code, translation or monetary contributions.

About BookWyrm

What it is and isn't

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.

The role of 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

Since the project is still in its early stages, the features are growing every day, and there is plenty of room for suggestions and ideas. Open an issue to get the conversation going!

  • Posting about books
    • Compose reviews, with or without ratings, which are aggregated in the book page
    • Compose other kinds of statuses about books, such as:
      • Comments on a book
      • Quotes or excerpts
    • Reply to statuses
    • View aggregate reviews of a book across connected BookWyrm instances
    • Differentiate local and federated reviews and rating in your activity feed
  • Track reading activity
    • Shelve books on default "to-read," "currently reading," and "read" shelves
    • Create custom shelves
    • Store started reading/finished reading dates, as well as progress updates along the way
    • Update followers about reading activity (optionally, and with granular privacy controls)
    • Create lists of books which can be open to submissions from anyone, curated, or only edited by the creator
  • Federation with ActivityPub
    • Broadcast and receive user statuses and activity
    • Share book data between instances to create a networked database of metadata
    • Identify shared books across instances and aggregate related content
    • Follow and interact with users across BookWyrm instances
    • Inter-operate with non-BookWyrm ActivityPub services (currently, Mastodon is supported)
  • Granular privacy controls
    • Private, followers-only, and public privacy levels for posting, shelves, and lists
    • Option for users to manually approve followers
    • Allow blocking and flagging for moderation

The 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.