Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wireapp/wire-desktop

:computer: Wire for desktop
https://github.com/wireapp/wire-desktop

desktop electron hacktoberfest wire

Last synced: 27 days ago
JSON representation

:computer: Wire for desktop

Awesome Lists containing this project

README 

        
# Wire™



![Wire logo](https://github.com/wireapp/wire/blob/master/assets/logo.png?raw=true)



This repository is part of the source code of Wire. You can find more information at [wire.com](https://wire.com) or by contacting [email protected].



You can find the published source code at [github.com/wireapp/wire](https://github.com/wireapp/wire).



For licensing information, see the attached LICENSE file and the list of third-party licenses at [wire.com/legal/licenses/](https://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.



## Wire Desktop



Cross platform desktop app, wrapping the [wire-webapp](https://github.com/wireapp/wire-webapp). Based on [Electron](https://electronjs.org).



### Prerequisites



- [Node.js](https://nodejs.org/) >= 10

- Npm

- Git

- Yarn (Install using the official instructions at https://yarnpkg.com/lang/en/docs/install/, and not using the package recommended by apt-get)



### Install Dependencies



```shell

sudo apt install git npm nodejs

npm install --global yarn

```



### Clone



```shell

git clone https://github.com/wireapp/wire-desktop.git

cd wire-desktop

yarn

```



### Start



```shell

yarn start

```



### Test



```shell

yarn test

```



### Deployment



| Stage | Branch | Action | Version |

| :-- | :-- | :-- | :-- |

| 1 (Feature development) | (varies) | commit | x.y+3 (e.g. 3.20) |

| 2 (Nightly test automation) | [dev](https://github.com/wireapp/wire-desktop/tree/dev) | commit or squash merge from feature branch | x.y+2 (e.g. 3.19) |

| 3 (Internal release) | [staging](https://github.com/wireapp/wire-desktop/tree/staging) | merge (don't squash) from [dev](https://github.com/wireapp/wire-desktop/tree/dev) | x.y+1 (e.g. 3.18) |

| 4 (Production release) | [main](https://github.com/wireapp/wire-desktop/tree/main) | merge (don't squash) from [staging](https://github.com/wireapp/wire-desktop/tree/staging) | x.y (e.g. 3.17) |



**Compare Views**



1. Updates from "dev" to "staging" (changelog): https://github.com/wireapp/wire-desktop/compare/staging...dev

1. Updates from "staging" to "main" (changelog): https://github.com/wireapp/wire-desktop/compare/main...staging



### Tasks



```shell

# Build for macOS

yarn build:macos



# Build for Windows

yarn build:win



# Build for Linux

yarn build:linux

```



### Other Linux targets



If you would like to build for another Linux target, run the following command:



```shell

export LINUX_TARGET=

yarn build:linux

```



Replace `` with your desired target (e.g. `rpm`). Have a look at the [documentation for `electron-builder`](https://www.electron.build/configuration/linux) for the available targets. Multiple targets can be combined by comma separation (e.g. `rpm,deb`). Note that we cannot offer support for uncommon targets.



Furthermore, you can disable [asar packaging](https://www.electronjs.org/docs/latest/tutorial/application-distribution/) (not recommended, but e.g. needed for target `dir`) by setting `ENABLE_ASAR="false"` before building. Example:



```shell

export ENABLE_ASAR="false"

yarn build:linux

```



### Troubleshooting



If you are having troubles building Wire for Desktop, then [our troubleshooting page](https://github.com/wireapp/wire-desktop/wiki/Troubleshooting) might be of help.



### Translations



All Wire translations are crowdsourced via [Crowdin](https://crowdin.com/projects/wire).



### Install wire-desktop under Linux



You can of course use the webapp in your browser, but if you prefer to install wire-desktop, continue reading here:



https://github.com/wireapp/wire-desktop/wiki/How-to-install-Wire-for-Desktop-on-Linux