Wire™

This repository is part of the source code of Wire. You can find more information at wire.com or by contacting opensource@wire.com.

You can find the published source code at github.com/wireapp/wire.

For licensing information, see the attached LICENSE file and the list of third-party licenses at wire.com/legal/licenses/.

If you compile the open source software that we make available from time to time to develop your own mobile, desktop or web application, and cause that application to connect to our servers for any purposes, we refer to that resulting application as an “Open Source App”. All Open Source Apps are subject to, and may only be used and/or commercialized in accordance with, the Terms of Use applicable to the Wire Application, which can be found at https://wire.com/legal/#terms. Additionally, if you choose to build an Open Source App, certain restrictions apply, as follows:

a. You agree not to change the way the Open Source App connects and interacts with our servers; b. You agree not to weaken any of the security features of the Open Source App; c. You agree not to use our servers to store data for purposes other than the intended and original functionality of the Open Source App; d. You acknowledge that you are solely responsible for any and all updates to your Open Source App.

For clarity, if you compile the open source software that we make available from time to time to develop your own mobile, desktop or web application, and do not cause that application to connect to our servers for any purposes, then that application will not be deemed an Open Source App and the foregoing will not apply to that application.

No license is granted to the Wire trademark and its associated logos, all of which will continue to be owned exclusively by Wire Swiss GmbH. Any use of the Wire trademark and/or its associated logos is expressly prohibited without the express prior written consent of Wire Swiss GmbH.

How to build the open source client

Build

Installation

1. Install Node.js
2. Install Yarn
3. Run yarn
4. Rename .env.localhost to .env in order to run the app in a local environment
5. Use a browser with disabled web security (−−disable−web−security in Chrome) to circumvent CORS issues when connecting to our backend from localhost

Execution

Run yarn start and Wire's web app will be available at: https://localhost:8081/auth/

Testing

To launch the full test suite (types check + linting + server tests + app tests), simply run:

yarn test

Alternatively, you can test specific parts of the app:

yarn test:(server|types|app)

Development

Bypass Chrome's security restrictions for local development:

1. Add the following entry to your hosts file: 127.0.0.1 local.zinfra.io
2. Restart your Chrome browser with flags: --disable-web-security --ignore-certificate-errors --user-data-dir=...
3. Run yarn start

Host file location:

• On macOS / Linux the hosts file can be found at: /etc/hosts
• On Windows 10 the hosts file can be found at: %WINDIR%\system32\drivers\etc\hosts

Optional: If your browser does not trust the certificate from "local.zinfra.io":

1. Download mkcert
2. Set CAROOT env variable to ./server/certificate
3. Run mkcert -install

Deployment

General workflow

Staging Bumps for internal releases

Actions

1. Get commit ID which has been approved by QA team
2. run yarn release:staging <commitId> (if the commit ID is omitted, the latest commit from dev will be used).
3. Example:

   yarn release:staging 90fda951916f0d60a5bffce69a7267830e313391
   

4. Enter "yes"

If everything is done right, you will see a Travis CI job in the build pipeline based on the new tag:

RC testing

Before RC testing we create a merge commit (don't squash!) from "dev" to "master" branch, so that our QA team can run tests on the latest version of our app.

Production Release

Similar to "Staging Bumps" with the exception that you need to run yarn release:production <commitId> (if the commit ID is omitted, the latest commit from master will be used).

Example:

yarn release:production 90fda951916f0d60a5bffce69a7267830e313391

Release notes

Release notes need to be generated with yarn changelog after merging to "master" and before creating the new production release tag. Release notes will be locally available (not committed to the repository) in CHANGELOG.md and sent to our marketing team to create release notes on Medium.

Manual Deployments

Based on the git branch, builds get deployed automatically by Travis CI. In case Travis CI is not working, a manual deployment can be triggered using yarn deploy.

A manual deployment requires the local setup of the Elastic Beanstalk Command Line Interface (EB CLI). Manual deployments are also based on branch defaults which are configured here.

Status

Translations

All Wire translations are crowdsourced via Crowdin.

Add new strings

1. Install Crowdin CLI v3
2. Verify you have a keys/crowdin.yaml in place with the project's API Key and your personal access token (you may have to create one).
3. Add string variable and text to "i18n/en-US.json"
4. Run yarn translate:upload
5. Verify your string shows up on Crowdin project: wire-webapp
6. Add translation on Crowdin
7. Approve translation on Crowdin
8. Run yarn translate:download

Template of "keys/crowdin.yaml" (you need to create this file yourself):

api_token: your-personal-access-token-from-crowdin
api_key: wire-webapp-api-key-from-crowdin

Contributing

Contributions are welcome! Feel free to check our issues page.

The following commits will help you getting started quickly with our code base:

• Show a modal / pop-up