6
6
Fork
You've already forked bookwyrm
1
Social reading and reviewing, decentralized with ActivityPub
  • Python 72.9%
  • HTML 23.5%
  • JavaScript 1.7%
  • SCSS 1.3%
  • Shell 0.6%
Mouse Reeve bc870a305f
 Merge pull request #2962 from jderuiter/mypy-isbn 
Type annotations and tests for isbn
2023年09月01日 17:05:01 -07:00
.github Added mypy to scripts and workflow, and some first annotations for celerywyrm 2023年07月22日 13:27:43 +02:00
bookwyrm Merge pull request #2962 from jderuiter/mypy-isbn 2023年09月01日 17:05:01 -07:00
celerywyrm Added mypy to scripts and workflow, and some first annotations for celerywyrm 2023年07月22日 13:27:43 +02:00
contrib Switch from priority queues to function-based queues 2023年07月20日 12:25:30 -04:00
dev-tools Upgrade development black to 22.12.0 2023年02月02日 12:36:34 +01:00
locale Include Dutch locale 2023年07月23日 21:27:42 +02:00
nginx Re-comment nginx config 2023年01月11日 16:56:31 -08: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 spelling: default 2023年04月04日 20:02:54 -04: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 Adds line length and import-error to .pylintrc 2022年07月02日 10:50:17 -07:00
bw-dev Include Dutch locale 2023年07月23日 21:27:42 +02:00
CODE_OF_CONDUCT.md [lint] Fix indentation in .md files. 2021年03月04日 19:05:01 +01: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 Switch from priority queues to function-based queues 2023年07月20日 12:25:30 -04:00
Dockerfile Go back to one requirements.txt, simplify workflow 2022年06月05日 14:57:42 -07:00
FEDERATION.md clean up and add stopped-reading shelf type 2023年07月03日 08:38:53 +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
mypy.ini Merge branch 'main' into mypy-isbn 2023年08月22日 11:41:34 +02:00
pytest.ini Updates tests env 2022年01月09日 12:04:45 -08:00
README.md Fix Quick Typo 2022年11月18日 23:24:18 -08:00
redis.conf Use redis with password in dev 2022年01月05日 08:52:28 -08:00
requirements.txt Added mypy to scripts and workflow, and some first annotations for celerywyrm 2023年07月22日 13:27:43 +02:00
SECURITY.md Create SECURITY.md 2022年06月30日 05:46:41 +01:00
update.sh Use more portable shebang for dev scripts 2023年03月07日 13:39:18 -05: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.

Links

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.