Package: matrix-angular-sdk
Matrix Angular SDK!DANGER!matrix-angular-sdk is not currently being maintained or developed by the core
team, and whilst stable it has some serious performance issues; Angular makes it
a bit too easy to shoot yourself in the foot and doesn’t help you escape when
you do so.  All of our current focus is going into the
https://github.com/matrix-org/matrix-js-sdk, https://github.com/matrix-org/matrix-react-sdk
and https://github.com/matrix-org/matrix-react-skin stack instead - please use
those rather than this if you want support from the core team.  Thanks!This project provides AngularJS services for implementing theClient-Server APIonMatrix: an open standard for interoperable Instant Messaging and VoIP. It
comes shipped withSynapse: a home server reference implementation.This project also provides a complete, stand-alone client which can communicate
with Matrix home servers using a web browser.TheSynapsehomeserver ships the latest stable version of this library.  If you
wish it to serve up a development copy instead, then you must configure this
checkout to be picked up by synapse:$ python setup.py develop --userRunningTo run the stand-alone client, thesyweb/webclientfolder must be hosted.
This can most easily be achieved by:cd syweb/webclient
python -m SimpleHTTPServerNavigate tohttp://localhost:8000to see the client.Bugs / Feature RequestsThink you’ve found a bug? Want a new feature on the client? Please open an issue
on JIRA:Create an account and login tohttps://matrix.org/jiraNavigate to theSYWEBproject.ClickCreate Issue- Please be as descriptive as possible, with reproduction
steps if possible.All issues in JIRA arepublic.ContributingWant to fix a bug or add a new feature? Check JIRA first to see if someone else is
handling this issue. If no one is actively working on the issue, then please fork
thedevelopbranch when writing your fix, and open a pull request when you’re
ready. Do not base your pull requests offmaster.ConfigurationThe web client can be configured by adding aconfig.jsfile in thesyweb/webclientdirectory. This includes configuration for setting up ReCaptcha.
An example file can be found atsyweb/webclient/config.sample.js.StructureTheappdirectory contains the SDK, which is split up into subfolders depending
on the logical scope of the code. Thecomponentsdirectory contains reusable
components which are used in many places. More specific directories such ashomeandsettingscontain code specific to that part of the app: e.g. the home screen
and settings page respectively.TheClient-Server APIis encapsulated as an AngularJS service calledmatrixService.
There are also complementary services such aseventStreamServicewhich handle more
complex non-HTTP client logic.Services can be used independently provided their dependencies are satisfied.matrixServiceis provided at the lowest level, as it just wraps the raw HTTP calls.modelServiceallows models of matrix objects to be accessed, such asUser,Room,RoomStateandRoomMember, and provides convenience functions to perform
HTTP calls on these objects (e.g.Room.leave).eventHandlerServiceinterprets raw Matrix events and determines what needs to be
stored with themodelService.eventStreamServicecontrols long-polling behaviour on the/eventsHTTP call.typingServicecontrols the submission of typing events into a room.presenceServicecontrols the submission of presence events.Alternatively, you can use different controllers and html templates and leave the services
to work together as is.TestsTests are contained in thetest directory. They require
Karma (running PhantomJS) and Jasmine 2.x+ in order to run. Assuming you have the
required karma plugins, you can run the tests by runningkarma startin the
test directory.AttributionsFile icons are taken fromhttp://medialoot.com/item/free-flat-filetype-icons/and
distributed under the terms of the Paid License (invoice #7355)Keyboard and GIF icon from icons8:http://icons8.com/