Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaime Guajardo committed Mar 20, 2017
2 parents 73f5518 + de166e0 commit d597c2f
Show file tree
Hide file tree
Showing 143 changed files with 2,346 additions and 2,451 deletions.
30 changes: 30 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Coding guidelines

Contributions to TogetherStream should use the good coding style. Please refer to the [Swift API coding guidelines](https://swift.org/documentation/api-design-guidelines/) and best practices for other languages.

## Documentation

All code changes should include comments describing the design, assumptions, dependencies, and non-obvious aspects of the implementation.
Hopefully the existing code provides a good example of appropriate code comments.
If necessary, make the appropriate updates in the README.md and other documentation files.

## Contributing your changes

1. If one does not exist already, open an issue that your contribution is going to resolve or fix.
1. Make sure to give the issue a clear title and a very focused description.
2. Make a branch from the develop branch using the following naming convention:
1. `YOUR_INITIALS/ISSUE#-DESCRIPTIVE-NAME`
2. For example, `kb/94-create-contributingmd` was the branch that had the commit containing this
tutorial.
3. Commit your changes!
4. When you have completed making all your changes, create a Pull Request (PR) from your git manager
or our Github repo from your branch to master.
5. Fill in the template for the PR.
6. Contributions require sign-off. We require that any contributers agree to the [Developer's Certificate of Origin 1.1 (DCO)](http://elinux.org/Developer_Certificate_Of_Origin), otherwise your pull request will be rejected.
1. When committing using the command line you can sign off using the --signoff or -s flag. This adds a Signed-off-by line by the committer at the end of the commit log message.`git commit -s -m "Commit message"`
7. That's it, thanks for the contribution!

## Setting up your environment

Please refer to the [README](README.md) for setup instructions

8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Version:
Steps to Reproduce:
*
*
*

Expected Behavior:
Actual Behavior:
6 changes: 6 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Resolves #{Issue Number}
Proposed Changes:
* {Detailed list of changes}
*
*
DCO1.1 Signed-off-by: {name} <{email, do not delete <>}>
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,13 @@ backend/config/private
newrelic_agent.log
yarn.lock
backend/public/app/bower_components
backend/public/app/credentials.js

# Frontend
iOS/TogetherStream/TogetherStream/Configuration/private.plist

# Other
iOS/TogetherStream/TogetherStream/Assets.xcassets/AppIcon.appiconset/*
manifest.yml.prod
manifest.yml.staging
backend/**/private/*
201 changes: 0 additions & 201 deletions LICENSE

This file was deleted.

9 changes: 9 additions & 0 deletions LICENSE-IOS
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Copyright 2017 IBM Corporation

Together Stream is intended solely for use with an Apple iOS product and intended to be used in conjunction with officially licensed Apple development tools and further customized and distributed under the terms and conditions of your licensed Apple Developer Program.

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.
7 changes: 7 additions & 0 deletions LICENSE-NON-IOS
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright 2017 IBM Corporation

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.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,17 @@ Together Stream uses push notifications to send stream invites to users with the
3. Go through these steps to generate a `cert.pem` and a `key.pem` https://github.com/node-apn/node-apn/wiki/Preparing-Certificates
4. Add these certificates to `backend/config/private/`

### Google Analytics Configuration
To keep track of analytics, generate a configuration file by following the instructions here: https://developers.google.com/analytics/devguides/collection/ios/v3/
**Note** You can skip adding the Google Analytics SDK to the project since it was installed above.

*Skip Installation*
You can skip installing Google Analytics by removing the method `setupGoogleAnalytics` in the `AppDelegate` and `sendGoogleAnalyticsEvent` in `Utilities/Utils.swift`

### Backend Configuration
1. In `backend/config/private/credentials.js` replace the `accessTokenKey` and `refreshTokenKey` with a unique string exactly **32 characters** long. This is used to encrypt the access tokens and refresh tokens in the database.
2. Replace the `sessionSecret` with a unique string. This is used to encrypt the session tokens.
3. Replace the email `userName` and `domainName` with your email address (i.e. `userName@domainName`), the `password` with your email password, and the `displayUserName` and `displayDomainName` with what you want the emails to be sent from. You can use the same values for here as your actual `userName` and `domainName` if you wish.

### Cloud Configuration
1. Go to https://console.ng.bluemix.net and create an account if you do not already have one.
Expand All @@ -64,10 +72,6 @@ Make sure that when you are creating your container, you add your Facebook crede
"CSYNC_FACEBOOK_SECRET=asfdasdf"`
2. Add the public IP of the container as `csync_url` to the `private.plist` located at `iOS/TogetherStream/TogetherStream/Configuration`

### Google Analytics Configuration (Optional)
If you wish to keep track of analytics, you can add a configuration file by following the instructions here: https://developers.google.com/analytics/devguides/collection/ios/v3/
**Note** You can skip adding Google Analytics to the project since it was installed above.

## Local Configuration (Optional)
### Requirements
[npm](https://www.npmjs.com/) 4.1.2
Expand All @@ -83,3 +87,10 @@ If you wish to keep track of analytics, you can add a configuration file by foll
7. Follow the instructions here to allow connections to a http address: http://stackoverflow.com/questions/31254725/transport-security-has-blocked-a-cleartext-http
8. If you would like to run your Contexual Sync server locally as well, follow the instructions here: https://github.com/csync/csync-server#local-deployment.
Make sure you change the `private.plist` in the iOS app to the local Contextual Sync server.

## Disclaimer
Together Stream is intended solely for use with an Apple iOS product and intended to be used in conjunction with officially licensed Apple development tools and further customized and distributed under the terms and conditions of your licensed Apple Developer Program.

## Licenses
[iOS](LICENSE-IOS)
[Non-iOS](LICENSE-NON-IOS)
3 changes: 3 additions & 0 deletions backend/.bowerrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"directory" : "public/app/bower_components"
}
Loading

0 comments on commit d597c2f

Please sign in to comment.