summaryrefslogtreecommitdiff
path: root/docs/hacking/architecture.rst
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2017-10-02 20:29:38 +0200
committerKali Kaneko <kali@leap.se>2017-10-02 23:58:40 +0200
commitdd80e6083247446a44c22ac430620045aba287ef (patch)
tree2013ff98dec0f38cc7dd30fbd7e095ab5c4dee51 /docs/hacking/architecture.rst
parent0c497dbac737b6a92ad8662005fe152f7a9c1fe9 (diff)
[docs] split development docs
the page was becoming too cluttered.
Diffstat (limited to 'docs/hacking/architecture.rst')
-rw-r--r--docs/hacking/architecture.rst41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/hacking/architecture.rst b/docs/hacking/architecture.rst
new file mode 100644
index 00000000..c1e654ed
--- /dev/null
+++ b/docs/hacking/architecture.rst
@@ -0,0 +1,41 @@
+.. _architecture:
+
+The Bitmask Architecture
+========================
+
+The Core
+--------
+
+The main bitmask-dev repo orchestrates the launching if the bitmaskd daemon.
+This is a collection of services that launches the vpn and mail services.
+bitmask vpn, mail and keymanager are the main modules, and soledad is one of the
+main dependencies for the mail service.
+
+The Qt gui
+----------
+
+The Qt gui is a minimalistic wrapper that uses PyQt5 to launch the core and
+display a qt-webkit browser rendering the resources served by the core. Its main
+entrypoint is in ``gui/app.py``.
+
+The Javascript UI
+-----------------
+
+A modern javascript app is the main Bitmask Frontend. For instructions on how
+to develop with the js ui, refer to :ref:`how to develop for the UI<uidev>`.
+
+
+The Thunderbird Extension
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The development for the Thunderbird Extension happens on `this repo`_.
+This extension gets published to the `mozilla addons page`_.
+
+.. _`this repo`: https://0xacab.org/leap/bitmask_thunderbird
+.. _`mozilla addons page`: https://addons.mozilla.org/en-US/thunderbird/addon/bitmask
+
+
+What Next?
+----------
+
+Have a look at the contribution guide.