Home

Awesome

Wire™

We are hiring

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

Prerequisites:

  1. Install Node.js
  2. Install Yarn

1. Fetching dependencies and configurations

  1. Run yarn

    • This will install all dependencies and fetch a configuration for the application.

2. Build & run

Development

  1. Rename .env.localhost to .env in order to configure the application. This configuration can override/extend the configuration from the previous step.
  2. Add the following entries to your hosts file (macOS / Linux: /etc/hosts, Windows 10: %WINDIR%\system32\drivers\etc\hosts):
    • 127.0.0.1 local.wire.com (to connect with production backend)
    • 127.0.0.1 local.zinfra.io (to connect with staging backend)
  3. Run yarn start and Wire's web app will be available at: https://local.zinfra.io:8081/auth/

Install the self-signed certificate

If you would like your browser to trust the certificate from "local.wire.com" or "local.zinfra.io":

  1. Download mkcert
  2. Set the CAROOT environment variable to <WebApp Dir>/server/certificate
  3. Run mkcert -install

Production

  1. Run yarn build:prod
  2. Run cd server && yarn start:prod

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)

CI Status

CI Lint styled with prettier

Translations

All Wire translations are crowdsourced via Crowdin.

Add new strings

Info:

Setup:

Create a keys/crowdin.yaml in this repository and add the following entries:

api_key: your-account-api-key
api_token: your-personal-access-token
project_identifier: wire-webapp
username: your-username

Usage:

  1. Add string variable to "src/script/strings.ts" (source for the React part of our app) and text to "i18n/en-US.json" (source for the Knockout part of our app)
  2. Create a PR and merge it after approval. When the PR gets merged, our CI will take care of uploading the english texts to Crowdin.

If our CI pipeline is broken, you still have the option to upload new strings manually. For this case do the following:

  1. Install Crowdin CLI v3
  2. Verify you have a keys/crowdin.yaml in place
  3. Run yarn translate:upload

Once translations are uploaded on Crowdin, our (and external) translators can translate the new strings on Crowdin. There is a script that will run to create PRs with translation updates. As an alternative, translations can be downloaded the following way:

  1. Verify your string shows up on Crowdin project: wire-webapp
  2. Add translation on Crowdin
  3. Approve translation on Crowdin
  4. Run yarn translate:download

Contributing

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

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