yul/bookwyrm-mastodon
1
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

More code cleanup and readme

Browse Source
This commit is contained in:
Mouse Reeve
2020-01-28 12:13:28 -08:00
parent 383530458d
commit f06b715f45
3 changed files with 39 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -27,3 +27,16 @@ This creates two users, `mouse@your-domain.com` with password `password123` and
And go to the app at localhost:8000
For most testing, you'll want to use ngrok. Remember to set the DOMAIN in settings.py to your ngrok domain.
## 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
messages, as well as inboxes and webfinger, live in `fedireads/incoming.py`. Misc api functions live in `fedireads/api.py`, which is
probably not a good name for that file.
Connection to openlibrary.org to get book data is handled in `fedireads/openlibrary.py`.