bookwyrm/README.md

52 lines
2.4 KiB
Markdown
Raw Normal View History

2020-01-27 05:52:24 +00:00
# fedireads
2020-01-27 22:16:56 +00:00
Social reading and reviewing, decentralized with ActivityPub
2020-01-28 02:59:49 +00:00
## Setting up the developer environment
You will need postgres installed and running on your computer.
``` bash
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
createdb fedireads
```
Create the psql user in `psql fedireads`:
``` psql
CREATE ROLE fedireads WITH LOGIN PASSWORD 'fedireads';
GRANT ALL PRIVILEGES ON DATABASE fedireads TO fedireads;
```
Initialize the database (or, more specifically, delete the existing database, run migrations, and start fresh):
2020-01-28 02:59:49 +00:00
``` bash
./rebuilddb.sh
```
2020-01-29 03:05:59 +00:00
This creates two users, `mouse` with password `password123` and `rat` with password `ratword`.
2020-01-28 02:59:49 +00:00
2020-01-28 20:13:28 +00:00
And go to the app at `localhost:8000`
2020-01-28 02:59:49 +00:00
For most testing, you'll want to use ngrok. Remember to set the DOMAIN in `.env` to your ngrok domain.
2020-01-28 20:13:28 +00:00
## Structure
All the url routing is in `fedireads/urls.py`. This includes the application views (your home page, user page, book page, etc),
application endpoints (things that happen when you click buttons), and federation api endpoints (inboxes, outboxes, webfinger, etc).
The application views and actions are in `fedireads/views.py`. The internal actions call api handlers which deal with federating content.
Outgoing messages (any action done by a user that is federated out), as well as outboxes, live in `fedireads/outgoing.py`, and all handlers for incoming
2020-02-11 23:17:21 +00:00
messages, as well as inboxes and webfinger, live in `fedireads/incoming.py`. Connection to openlibrary.org to get book data is handled in `fedireads/openlibrary.py`.
2020-01-28 20:13:28 +00:00
2020-02-11 23:17:21 +00:00
The UI is all django templates because that is the default. You can replace it with a complex javascript framework over my ~dead body~ mild objections.
2020-01-28 20:58:32 +00:00
## Thoughts and considerations
### What even are books
It's important for this application to function that books can be identified reliably across different instances. I'm using OpenLibrary.org data, which works well (thanks OpenLibrary!) and I'm treating it as canonical and not the copies in the local databases. This means that instances will be consistent, but the major downside is that if users want to modify books or add books that aren't available, they need to do it on OpenLibrary, rather than their own instance.
2020-01-28 20:58:32 +00:00
2020-02-11 07:00:38 +00:00
### Explain "review"
There's no actual reason to be beholden to simple 5 star reviews with a text body. Are there other ways of thinking about a review
that could be represented in a database?