matty/ncd-fe
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix administration and development docs

Browse Source
This commit is contained in:
Sean King
2020-08-30 13:43:40 -06:00
parent 55fe6eb179
commit d7bfe3305b
8 changed files with 6 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/development/how-it-works.md Normal file
View File

@ -0,0 +1,8 @@
# How it works
Soapbox FE is a [single-page application (SPA)](https://en.wikipedia.org/wiki/Single-page_application) that runs entirely in the browser with JavaScript.
It has a single HTML file, `index.html`, responsible only for loading the required JavaScript and CSS.
It interacts with the backend through [XMLHttpRequest (XHR)](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest).
It incorporates much of the [Mastodon API](https://docs.joinmastodon.org/methods/) used by Pleroma and Mastodon, but requires many [Pleroma-specific features](https://docs-develop.pleroma.social/backend/API/differences_in_mastoapi_responses/) in order to function.