diff options
| author | Matthew Hodgson <matthew@matrix.org> | 2014-08-13 15:23:06 +0100 |
|---|---|---|
| committer | Matthew Hodgson <matthew@matrix.org> | 2014-08-13 15:23:06 +0100 |
| commit | 31f2ec252c7e08c8ef7a04efb0fa321f7d9f39d5 (patch) | |
| tree | 1864f5e662468f4fb5bc9fce91612dbfff94100b /MAP.rst | |
| parent | Namespace all the Federation HTTP URLs to /matrix/federation/v1/... (diff) | |
| download | synapse-31f2ec252c7e08c8ef7a04efb0fa321f7d9f39d5.tar.xz | |
refactor the README a load more to make the quickstart more visible
Diffstat (limited to 'MAP.rst')
| -rw-r--r-- | MAP.rst | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/MAP.rst b/MAP.rst new file mode 100644 index 0000000000..0f8e9818a8 --- /dev/null +++ b/MAP.rst @@ -0,0 +1,35 @@ +Directory Structure +=================== + +Warning: this may be a bit stale... + +:: + + . + ├── cmdclient Basic CLI python Matrix client + ├── demo Scripts for running standalone Matrix demos + ├── docs All doc, including the draft Matrix API spec + │ ├── client-server The client-server Matrix API spec + │ ├── model Domain-specific elements of the Matrix API spec + │ ├── server-server The server-server model of the Matrix API spec + │ └── sphinx The internal API doc of the Synapse homeserver + ├── experiments Early experiments of using Synapse's internal APIs + ├── graph Visualisation of Matrix's distributed message store + ├── synapse The reference Matrix homeserver implementation + │ ├── api Common building blocks for the APIs + │ │ ├── events Definition of state representation Events + │ │ └── streams Definition of streamable Event objects + │ ├── app The __main__ entry point for the homeserver + │ ├── crypto The PKI client/server used for secure federation + │ │ └── resource PKI helper objects (e.g. keys) + │ ├── federation Server-server state replication logic + │ ├── handlers The main business logic of the homeserver + │ ├── http Wrappers around Twisted's HTTP server & client + │ ├── rest Servlet-style RESTful API + │ ├── storage Persistence subsystem (currently only sqlite3) + │ │ └── schema sqlite persistence schema + │ └── util Synapse-specific utilities + ├── tests Unit tests for the Synapse homeserver + └── webclient Basic AngularJS Matrix web client + + |