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 b5b1585dd5 nix: whoops, forgot a terminating semicolon in README example 5 days ago
.github Merge branch 'main' into production 2 weeks ago
bookwyrm Merge branch 'production' into nix 5 days ago
celerywyrm Merge branch 'production' into nix 5 days ago
locale Updates locales 6 days ago
nginx Merge branch 'main' into production 2 months ago
nix nix: whoops, forgot a terminating semicolon in README example 5 days ago
postgres-docker Add database to filename, don't install recommends 4 weeks ago
.coveragerc [lint] Fix missing new lines. 11 months ago
.dockerignore [lint] Fix missing new lines. 11 months ago
.editorconfig Add specific vendor file 5 months ago
.env.example Merge branch 'main' into production 1 week ago
.eslintignore [assets] Move some frontend assets to _vendor_ directories: 10 months ago
.eslintrc.js [assets] Document functions and variables: 10 months ago
.gitignore Merge branch 'production' into nix 2 months ago
.stylelintignore [assets] Move some frontend assets to _vendor_ directories: 10 months ago
.stylelintrc.js Use null to invalidate rules 2 weeks ago
CODE_OF_CONDUCT.md [lint] Fix indentation in .md files. 11 months ago
Dockerfile Adds html linting to test 4 months ago
LICENSE.md Rename License with a .md extension. 9 months ago
Makefile Using Poetry for dependency management and adjustments for docker 10 months ago
README.md Update README to reflect the nature of this branch 5 days ago
bw-dev Merge branch 'main' into production 1 week ago
crowdin.yml Update Crowdin configuration file 4 months ago
docker-compose.yml Merge branch 'main' into production 2 weeks ago
flake.lock nix: update Nixpkgs 5 days ago
flake.nix nix: add flake 7 months ago
manage.py Updates migrations 1 year ago
package.json Updates NPM dependencies to resolve security alerts 2 weeks ago
poetry.lock Merge branch 'production' into nix 5 days ago
pyproject.toml Merge branch 'production' into nix 5 days ago
pytest.ini Updates tests env 2 weeks ago
redis.conf replicate password line 1 year ago
yarn.lock Updates NPM dependencies to resolve security alerts 2 weeks ago

README.md

BookWyrm Nix Edition

Social reading and reviewing, decentralized with ActivityPub. 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.

Contents

Joining BookWyrm

BookWyrm is still a young piece of software, and isn't at the level of stability and feature-richness that you'd find in a production-ready application. But it does what it says on the box! If you'd like to join an instance, you can check out the instances list.

You can request an invite by entering your email address at https://bookwyrm.social.

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

Book data

The application is set up to share book and author data between instances, and get book data from arbitrary outside sources. Right now, the only connector is to OpenLibrary, but other connectors could be written.

Set up Bookwyrm

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