Ingen beskrivning

Mouse Reeve d637b8033f Merge branch 'main' into production 9 månader sedan
.github a884825b3c Check no missing migrations in django-tests workflow 10 månader sedan
bookwyrm 2a85378456 Removes part of migration causing upgrade issues 9 månader sedan
celerywyrm 75f37d7361 Added mypy to scripts and workflow, and some first annotations for celerywyrm 1 år sedan
contrib 439b0bcd27 Merge branch 'main' into production 9 månader sedan
dev-tools 09b2dea995 dev-tools: ensure we install Node from upstream 9 månader sedan
locale e2249f2515 Updates locales 9 månader sedan
nginx 8fa8d433aa Re-comment nginx config 1 år sedan
postgres-docker c58689ae20 Adjust sample postgres-docker cron file 1 år sedan
updates ee973c7d72 Adds celerybeat update script 2 år sedan
.coveragerc 99d2b34a1e [lint] Fix missing new lines. 3 år sedan
.dockerignore f8e60f4a89 Enable Azure BlobStorage as an alternative to AWS S3 1 år sedan
.editorconfig fcd41aaf06 Add specific vendor file 3 år sedan
.env.example c92cdec36e spelling: default 1 år sedan
.eslintignore cbed5e331b [assets] Move some frontend assets to _vendor_ directories: 3 år sedan
.eslintrc.js 52d2f0e331 [assets] Document functions and variables: 3 år sedan
.gitignore f54d4863fe Updates .gitignore for themes 2 år sedan
.prettierignore 40bb9112fd .prettierignore to vendor 2 år sedan
.prettierrc cd247a6689 Update .prettierrc 11 månader sedan
.pylintrc f68c80dfff Adds line length and import-error to .pylintrc 2 år sedan
CODE_OF_CONDUCT.md 4a8d9bee73 [lint] Fix indentation in .md files. 3 år sedan
Dockerfile 6584cb6404 Go back to one requirements.txt, simplify workflow 2 år sedan
FEDERATION.md b05f2e99e8 undo moves 1 år sedan
LICENSE.md eb9935039e Rename License with a .md extension. 3 år sedan
README.md c7ac936a9a Fix Quick Typo 1 år sedan
SECURITY.md 1609b9b74c Create SECURITY.md 2 år sedan
VERSION b6f7a5c257 Bump version to 0.7.1. 9 månader sedan
bump-version.sh 00bf2903bc Bumped version number to 0.7.0 (#3052) 11 månader sedan
bw-dev 9b3f4933ac Fixes language code for Ukrainian 9 månader sedan
complete_bwdev.fish 75f37d7361 Added mypy to scripts and workflow, and some first annotations for celerywyrm 1 år sedan
complete_bwdev.sh 75f37d7361 Added mypy to scripts and workflow, and some first annotations for celerywyrm 1 år sedan
complete_bwdev.zsh 75f37d7361 Added mypy to scripts and workflow, and some first annotations for celerywyrm 1 år sedan
crowdin.yml 21902b09c4 Update Crowdin configuration file 3 år sedan
docker-compose.yml 439b0bcd27 Merge branch 'main' into production 9 månader sedan
manage.py c7883cd615 Updates migrations 4 år sedan
mypy.ini 6e9f64262c Merge branch 'main' into mypy-utils 1 år sedan
pytest.ini 9d502f5ee2 Use setUpTestData() to speed up tests 9 månader sedan
redis.conf c5bcde0ee4 replicate password line 3 år sedan
requirements.txt 439b0bcd27 Merge branch 'main' into production 9 månader sedan
update.sh abb5dc857e Use more portable shebang for dev scripts 1 år sedan

README.md

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.