-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 9bac572
Showing
99 changed files
with
11,223 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Specifies intentionally untracked files to ignore when using Git | ||
# http://git-scm.com/docs/gitignore | ||
|
||
*~ | ||
*.sw[mnpcod] | ||
*.log | ||
*.tmp | ||
*.tmp.* | ||
log.txt | ||
*.sublime-project | ||
*.sublime-workspace | ||
.vscode/ | ||
npm-debug.log* | ||
|
||
.idea/ | ||
.ionic/ | ||
.sourcemaps/ | ||
.sass-cache/ | ||
.tmp/ | ||
.versions/ | ||
coverage/ | ||
dist/ | ||
node_modules/ | ||
tmp/ | ||
temp/ | ||
platforms/ | ||
plugins/ | ||
plugins/android.json | ||
plugins/ios.json | ||
www/ | ||
$RECYCLE.BIN/ | ||
|
||
.DS_Store | ||
Thumbs.db | ||
UserInterfaceState.xcuserstate | ||
google-services.json | ||
GoogleService-Info.plist | ||
|
||
.editorconfig |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
Contribution Agreement | ||
====================== | ||
|
||
As a contributor, you represent that the code you submit is your | ||
original work or that of your employer (in which case you represent | ||
you have the right to bind your employer). By submitting code, you | ||
(and, if applicable, your employer) are licensing the submitted code | ||
to LinkedIn and the open source community subject to the BSD 2-Clause | ||
license. | ||
|
||
Responsible Disclosure of Security Vulnerabilities | ||
================================================== | ||
|
||
Please do not file reports on Github for security issues. Please | ||
review the guidelines at (https://www.linkedin.com/help/linkedin/answer/62924). | ||
|
||
Tips for Getting Your Pull Request Accepted | ||
=========================================== | ||
|
||
1. Make sure all new features are tested and the tests pass. | ||
2. Bug fixes must include a test case demonstrating the error that it | ||
fixes. | ||
3. Open an issue first and seek advice for your change before | ||
submitting a pull request. Large features which have never been | ||
discussed are unlikely to be accepted. **You have been warned.** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
BSD 2-CLAUSE LICENSE | ||
|
||
Copyright 2019 Linkedin | ||
All Rights Reserved. | ||
|
||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: | ||
|
||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. | ||
|
||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | ||
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,171 @@ | ||
Copyright 2019 LinkedIn Corporation | ||
All Rights Reserved. | ||
|
||
Licensed under the BSD 2-Clause License (the "License"). See License in the project root for license information. | ||
|
||
Distributions of the Iris mobile app include: | ||
|
||
Handlebars.js: | ||
Copyright (C) 2011-2017 by Yehuda Katz | ||
https://github.com/wycats/handlebars.js | ||
|
||
he.js: | ||
Copyright Mathias Bynens <https://mathiasbynens.be/> | ||
https://github.com/mathiasbynens/he | ||
|
||
crypto-js: | ||
Copyright (c) 2009-2013 Jeff Mott | ||
Copyright (c) 2013-2016 Evan Vosberg | ||
https://github.com/brix/crypto-js | ||
|
||
cordova-plugin-whitelist: | ||
Copyright The Apache Software Foundation | ||
https://github.com/apache/cordova-plugin-whitelist | ||
|
||
cordova-plugin-device: | ||
Copyright The Apache Software Foundation | ||
https://github.com/apache/cordova-plugin-device | ||
|
||
cordova-plugin-splashscreen: | ||
Copyright The Apache Software Foundation | ||
https://github.com/apache/cordova-plugin-splashscreen | ||
|
||
cordova-plugin-inappbrowser: | ||
Copyright The Apache Software Foundation | ||
https://github.com/apache/cordova-plugin-inappbrowser | ||
|
||
cordova-plugin-ionic-webview: | ||
Copyright Ionic | ||
https://github.com/ionic-team/cordova-plugin-ionic-webview | ||
|
||
cordova-plugin-ionic-webview: | ||
Copyright 2015-present Drifty Co. | ||
https://github.com/ionic-team/cordova-plugin-ionic-keyboard | ||
|
||
phonegap-plugin-barcodescanner: | ||
Copyright 2010 Matt Kane | ||
Copyright 2011 IBM Corporation | ||
Copyright 2012-2017 Adobe Systems | ||
https://github.com/phonegap/phonegap-plugin-barcodescanner | ||
|
||
angular: | ||
Copyright (c) 2010-2019 Google LLC. http://angular.io/license | ||
https://github.com/angular/angular | ||
|
||
ionic-native: | ||
Copyright 2015-present Drifty Co. | ||
https://github.com/ionic-team/ionic-native | ||
|
||
phonegap-plugin-push: | ||
Copyright 2012-2017 Adobe System | ||
https://github.com/phonegap/phonegap-plugin-push | ||
|
||
cordova-android: | ||
Copyright The Apache Software Foundation | ||
https://github.com/apache/cordova-android | ||
|
||
cordova-ios: | ||
Copyright The Apache Software Foundation | ||
https://github.com/apache/cordova-ios | ||
|
||
cordova-support-google-services: | ||
Copyright (c) 2017 Maksim Chemerisuk | ||
https://github.com/chemerisuk/cordova-support-google-services | ||
|
||
ionic-plugin-deeplinks: | ||
Copyright 2016-present Drifty Co. | ||
https://github.com/ionic-team/ionic-plugin-deeplinks | ||
|
||
ionicons: | ||
Copyright (c) 2015-present Ionic (http://ionic.io/) | ||
https://github.com/ionic-team/ionicons | ||
|
||
rxjs: | ||
Copyright (c) 2015-2018 Google, Inc., Netflix, Inc., Microsoft Corp. and contributors | ||
https://github.com/ReactiveX/rxjs | ||
|
||
sw-toolbox: | ||
https://github.com/GoogleChromeLabs/sw-toolbox | ||
|
||
zone.js: | ||
Copyright (c) 2016-2018 Google, Inc. | ||
https://github.com/angular/zone.js/blob/master/LICENSE | ||
|
||
OPEN SOURCE LICENSES: | ||
The MIT License (MIT) | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
|
||
|
||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
1. Definitions. | ||
|
||
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. | ||
|
||
Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. | ||
|
||
Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. | ||
|
||
4. Redistribution. | ||
|
||
You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: | ||
|
||
You must give any other recipients of the Work or Derivative Works a copy of this License; and | ||
You must cause any modified files to carry prominent notices stating that You changed the files; and | ||
You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and | ||
If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. | ||
|
||
5. Submission of Contributions. | ||
|
||
Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. | ||
|
||
This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. | ||
|
||
Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. | ||
|
||
In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. | ||
|
||
While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
Introduction | ||
------------- | ||
|
||
Iris is an on-call escalation management system built by Linkedin and used in production today. This repo provides a mobile frontend for Iris, allowing engineers to access incident data off-premises. Iris is: | ||
|
||
- **Simple:** This app gives its users a clean, focused UI for examining on-call alerts and their associated data. | ||
- **Customizable:** The content of each incident is user-defined, as is the way that data is displayed. Iris exposes a templating system that allows each application to define layouts for its incidents, empowering users to decide what data is important and how they wish to see it. | ||
- **Scalable:** Iris is used in production by Linkedin to handle all of its operational incidents (thousands per day). | ||
|
||
This repo provides a mobile interface for Iris. The primary codebase is available at [this repo](https://github.com/linkedin/iris) | ||
|
||
|
||
Getting Started | ||
--------------- | ||
|
||
The Iris mobile app is built on the Ionic 3 platform (https://ionicframework.com/). As such, it's largely written in Typescript and HTML, then compiled to run in a WebView on Android and iOS. The app communicates with [Iris API](https://github.com/linkedin/iris) through [Iris relay](https://github.com/linkedin/iris-relay). Both of these components are necessary for the app to function. To check out how the app works: | ||
|
||
- **Set up Iris API and Iris relay:** For an easy initial setup, see the Iris docker-compose repo [here](https://github.com/jrgp/iris-docker-compose). Docs for more complicated setup can be found at https://iris.claims/docs. | ||
- **Install the Ionic CLI:** Follow instructions [here](https://ionicframework.com/docs/cli) to download and install the Ionic CLI. This app is built on Ionic 3, so you may need to install a previous version. | ||
- **Run the app in-browser:** Running "ionic serve" should build the app, connect it to the docker-compose containers, and allow you to see what the app looks like. Note that this is a debug-mode setup; production deployment will require some configuration changes. | ||
|
||
|
||
Building native apps | ||
-------------------- | ||
To build the app for mobile devices, we leverage cordova through the Ionic platform. To do this: | ||
|
||
- **Set up Iris API and Iris relay:** For an easy initial setup, see the Iris docker-compose repo [here](https://github.com/jrgp/iris-docker-compose). Docs for more complicated setup can be found at https://iris.claims/docs. | ||
- **Configure .env.dev and .env.prod:** In .env.dev and .env.prod (located in the repo root), set `IRIS_BASE_URL` and `LOGIN_URL` according to where Iris relay is hosted. For example, this may look like `IRIS_BASE_URL=https://iris-relay.example.com` and `LOGIN_URL=https://iris-relay.example.com/saml/login/saml_idp` | ||
- **Configure Firebase push notifications:** After configuring the app with your Firebase project, you should be given the option to download a google-services.json or GoogleService-Info.plist file. | ||
- **Build using Ionic CLI:** For development builds, run `ionic cordova build $PLATFORM`. Production builds use `ionic cordova build --prod --release $PLATFORM` | ||
- **Configure code signing for iOS/Android:** For production builds, code signing is required to verify developer identity. The process for this differs depending on platform. See instructions for [iOS](https://developer.apple.com/support/code-signing/) and [Android](https://developer.android.com/studio/publish/app-signing) | ||
|
Oops, something went wrong.