Skip to content

Commit 405d938

Browse files
akashnimareakashnimare
authored
Update docs and code to point to new repo url.
This is because we have changed the repo name to zulip-desktop.
1 parent c6b7e9a commit 405d938

File tree

14 files changed

+2812
-547
lines changed

14 files changed

+2812
-547
lines changed

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Thanks for taking the time to contribute!
44

5-
The following is a set of guidelines for contributing to Zulip Electron Desktop Client. These are just guidelines, not rules, so use your best judgement and feel free to propose changes to this document in a pull request.
5+
The following is a set of guidelines for contributing to Zulip's desktop Client. These are just guidelines, not rules, so use your best judgement and feel free to propose changes to this document in a pull request.
66

77
## Getting Started
88

@@ -12,10 +12,10 @@ Zulip-Desktop app is built on top of [Electron](http://electron.atom.io/). If yo
1212

1313
* The whole Zulip documentation, such as setting up a development environment, setting up with the Zulip webapp project, and testing, can be read [here](https://zulip.readthedocs.io).
1414

15-
* If you have any questions regarding zulip-electron, open an [issue](https://github.com/zulip/zulip-electron/issues/new/) or ask it on [chat.zulip.org](https://chat.zulip.org/#narrow/stream/16-desktop).
15+
* If you have any questions regarding zulip-desktop, open an [issue](https://github.com/zulip/zulip-desktop/issues/new/) or ask it on [chat.zulip.org](https://chat.zulip.org/#narrow/stream/16-desktop).
1616

1717
## Issue
18-
Ensure the bug was not already reported by searching on GitHub under [issues](https://github.com/zulip/zulip-electron/issues). If you're unable to find an open issue addressing the bug, open a [new issue](https://github.com/zulip/zulip-electron/issues/new).
18+
Ensure the bug was not already reported by searching on GitHub under [issues](https://github.com/zulip/zulip-desktop/issues). If you're unable to find an open issue addressing the bug, open a [new issue](https://github.com/zulip/zulip-desktop/issues/new).
1919

2020
The [zulipbot](https://github.com/zulip/zulipbot) helps to claim an issue by commenting the following in the comment section: "**@zulipbot** claim". **@zulipbot** will assign you to the issue and label the issue as **in progress**. For more details, check out [**@zulipbot**](https://github.com/zulip/zulipbot).
2121

@@ -38,7 +38,7 @@ For example:
3838

3939

4040
## Pull Requests
41-
Pull Requests are always welcome.
41+
Pull Requests are always welcome.
4242

4343
1. When you edit the code, please run `npm run test` to check the formatting of your code before you `git commit`.
4444
2. Ensure the PR description clearly describes the problem and solution. It should include:

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Zulip Desktop Client
2-
[![Build Status](https://travis-ci.org/zulip/zulip-electron.svg?branch=master)](https://travis-ci.org/zulip/zulip-electron)
3-
[![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/zulip/zulip-electron?branch=master&svg=true)](https://ci.appveyor.com/project/akashnimare/zulip-electron/branch/master)
2+
[![Build Status](https://travis-ci.org/zulip/zulip-desktop.svg?branch=master)](https://travis-ci.org/zulip/zulip-desktop)
3+
[![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/zulip/zulip-desktop?branch=master&svg=true)](https://ci.appveyor.com/project/zulip/zulip-desktop/branch/master)
44
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
55
[![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://chat.zulip.org)
66

@@ -20,7 +20,7 @@ Please see the [installation guide](https://zulipchat.com/help/desktop-app-insta
2020

2121
# Contribute
2222

23-
First, join us on the [Zulip community server](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html)!
23+
First, join us on the [Zulip community server](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html)!
2424
Also see our [contribution guidelines](./CONTRIBUTING.md) and our [development guide](./development.md).
2525

2626
# License

‎app/main/linuxupdater.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const logger = new Logger({
1414
});
1515

1616
function linuxUpdateNotification() {
17-
let url = 'https://api.github.com/repos/zulip/zulip-electron/releases';
17+
let url = 'https://api.github.com/repos/zulip/zulip-desktop/releases';
1818
url = ConfigUtil.getConfigItem('betaUpdate') ? url : url + '/latest';
1919
const proxyEnabled = ConfigUtil.getConfigItem('useManualProxy') || ConfigUtil.getConfigItem('useSystemProxy');
2020

‎app/main/menu.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class AppMenu {
4949
{
5050
label: `Release Notes`,
5151
click() {
52-
shell.openExternal(`https://github.com/zulip/zulip-electron/releases/tag/v${app.getVersion()}`);
52+
shell.openExternal(`https://github.com/zulip/zulip-desktop/releases/tag/v${app.getVersion()}`);
5353
}
5454
}, {
5555
type: 'separator'

‎app/package-lock.json‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎app/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111
},
1212
"repository": {
1313
"type": "git",
14-
"url": "https://github.com/zulip/zulip-electron.git"
14+
"url": "https://github.com/zulip/zulip-desktop.git"
1515
},
1616
"bugs": {
17-
"url": "https://github.com/zulip/zulip-electron/issues"
17+
"url": "https://github.com/zulip/zulip-desktop/issues"
1818
},
1919
"main": "main/index.js",
2020
"keywords": [

‎app/renderer/about.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
url = "https://zulipchat.com";
3737
break;
3838
case 'license':
39-
url = "https://github.com/zulip/zulip-electron/blob/master/LICENSE";
39+
url = "https://github.com/zulip/zulip-desktop/blob/master/LICENSE";
4040
break;
4141
}
4242
shell.openExternal(url);

‎development.md‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Improve development guide
1+
# Improve development guide
22

33
# Development setup
44

@@ -15,32 +15,32 @@ Follow our [Git Guide](https://zulip.readthedocs.io/en/latest/git/setup.html) in
1515

1616
Jump to:
1717

18-
- [MacOS](https://github.com/zulip/zulip-electron/blob/master/development.md#macos)
19-
- [Ubuntu/Debian](https://github.com/zulip/zulip-electron/blob/master/development.md#ubuntudebian)
20-
- [Windows](https://github.com/zulip/zulip-electron/blob/master/development.md#windows)
18+
- [MacOS](https://github.com/zulip/zulip-desktop/blob/master/development.md#macos)
19+
- [Ubuntu/Debian](https://github.com/zulip/zulip-desktop/blob/master/development.md#ubuntudebian)
20+
- [Windows](https://github.com/zulip/zulip-desktop/blob/master/development.md#windows)
2121

2222

2323
## MacOS
2424

2525

2626
**Node JS**
27-
Go to the [Node.js Downloads page](https://nodejs.org/en/download/). Download Node.js for MacOS (`v6.9.0` or above recommended). Run the downloaded Node.js `.pkg` Installer. You're finished! To ensure Node.js has been installed, run `node -v` in your terminal - you should get something like `v6.9.0` or above
27+
Go to the [Node.js Downloads page](https://nodejs.org/en/download/). Download Node.js for MacOS (`v6.9.0` or above recommended). Run the downloaded Node.js `.pkg` Installer. You're finished! To ensure Node.js has been installed, run `node -v` in your terminal - you should get something like `v6.9.0` or above
2828

2929

30-
**if** [**NPM**](https://www.npmjs.com/get-npm) **and** [**node-gyp**](https://github.com/nodejs/node-gyp#installation) **don't come bundled with your Node.js installation, Download manually**
30+
**if** [**NPM**](https://www.npmjs.com/get-npm) **and** [**node-gyp**](https://github.com/nodejs/node-gyp#installation) **don't come bundled with your Node.js installation, Download manually**
3131

3232

33-
Now you are ready for next step [: Get Zulip Electron Code.](https://github.com/zulip/zulip-electron/blob/master/development.md#get-zulip-electron-code)
33+
Now you are ready for next step [: Get Zulip Desktop Code.](https://github.com/zulip/zulip-desktop/blob/master/development.md#get-zulip-desktop-code)
3434

3535

3636
## Ubuntu/Debian
37-
37+
3838

3939
If you’re in a hurry, you can copy and paste the following into your terminal
4040

41-
sudo apt install git nodejs node-gyp python build-essential snapcraft libxext-dev libxtst-dev lib xkbfile-dev libgconf-2-4
41+
sudo apt install git nodejs node-gyp python build-essential snapcraft libxext-dev libxtst-dev lib xkbfile-dev libgconf-2-4
4242

43-
after pasting you can jump to next step [: Get Zulip Electron Code](https://github.com/zulip/zulip-electron/blob/master/development.md#get-zulip-electron-code).
43+
after pasting you can jump to next step [: Get Zulip Desktop Code](https://github.com/zulip/zulip-desktop/blob/master/development.md#get-zulip-desktop-code).
4444

4545

4646
**For a step-by-step explanation, read on.**
@@ -49,7 +49,7 @@ after pasting you can jump to next step [: Get Zulip Electron Code](https://gith
4949

5050
`$ sudo apt-get install nodejs`
5151

52-
2. **Install** [**Node-gyp**](https://github.com/nodejs/node-gyp#installation)
52+
2. **Install** [**Node-gyp**](https://github.com/nodejs/node-gyp#installation)
5353

5454
3. **Python (v2.7.x recommended)**
5555

@@ -58,7 +58,7 @@ after pasting you can jump to next step [: Get Zulip Electron Code](https://gith
5858
4. **C++ compiler compatible with C++11**
5959

6060
`$ sudo apt install build-essential`
61-
61+
6262
5. **Snapcraft**
6363

6464
`$ sudo apt install snapcraft`
@@ -68,33 +68,33 @@ after pasting you can jump to next step [: Get Zulip Electron Code](https://gith
6868
`$ sudo apt install libxext-dev libxtst-dev libxkbfile-dev libgconf-2-4`
6969

7070

71-
**if** [**NPM**](https://www.npmjs.com/get-npm) **don't come bundled with your Node.js installation, Download manually**
71+
**if** [**NPM**](https://www.npmjs.com/get-npm) **don't come bundled with your Node.js installation, Download manually**
7272

7373

74-
Now you are ready for next step [: Get Zulip Electron Code.](https://github.com/zulip/zulip-electron/blob/master/development.md#get-zulip-electron-code)
74+
Now you are ready for next step [: Get Zulip Desktop Code.](https://github.com/zulip/zulip-desktop/blob/master/development.md#get-zulip-desktop-code)
7575

7676

7777
## Windows
7878

7979
**Node JS**
80-
Go to the [Node.js Downloads page](https://nodejs.org/en/download/). Download Node.js for windows (`v6.9.0` or above recommended). Run the downloaded Node.js `.msi` Installer. You're finished! To ensure Node.js has been installed, run `node -v` in your terminal - you should get something like `v6.9.0` or above
81-
80+
Go to the [Node.js Downloads page](https://nodejs.org/en/download/). Download Node.js for windows (`v6.9.0` or above recommended). Run the downloaded Node.js `.msi` Installer. You're finished! To ensure Node.js has been installed, run `node -v` in your terminal - you should get something like `v6.9.0` or above
81+
8282

8383
**Followings are optional yet recommended prerequisites -**
8484

85-
**Cmder**
85+
**Cmder**
8686
1. Download the [latest release](https://github.com/cmderdev/cmder/releases/)
8787
2. Extract the archive. *Note: This path should not be* `C:\Program Files` *or anywhere else that would require Administrator access for modifying configuration files*
8888
3. (optional) Place your own executable files into the `%cmder_root%\bin` folder to be injected into your PATH.
8989
4. Run `Cmder.exe`
90-
91-
**Chocolatey**
90+
91+
**Chocolatey**
9292
You can download chocolatey from here https://chocolatey.org/ and for Installing Chocolatey on your machine follow this steps
9393
1. First, ensure that you are using an administrative shell.
9494
2. Copy the text specific to your command shell - [cmd.exe](https://chocolatey.org/install#install-with-cmdexe) or [powershell.exe](https://chocolatey.org/install#install-with-powershellexe).
9595
3. Paste the copied text into your shell and press Enter.
9696
4. Wait a few seconds for the command to complete.
97-
5. If you don't see any errors, you are ready to use Chocolatey! Type `choco` or `choco -?`
97+
5. If you don't see any errors, you are ready to use Chocolatey! Type `choco` or `choco -?`
9898

9999

100100
**System specific dependencies**
@@ -105,16 +105,16 @@ Now you are ready for next step [: Get Zulip Electron Code.](https://github.com/
105105
C:\Windows\system32> npm install --global --production windows-build-tools
106106

107107

108-
**if** [**NPM**](https://www.npmjs.com/get-npm) **and** [**node-gyp**](https://github.com/nodejs/node-gyp#installation) **don't come bundled with your Node.js installation, Download manually**
108+
**if** [**NPM**](https://www.npmjs.com/get-npm) **and** [**node-gyp**](https://github.com/nodejs/node-gyp#installation) **don't come bundled with your Node.js installation, Download manually**
109109

110-
Now you are ready for next step [: Get Zulip Electron Code.](https://github.com/zulip/zulip-electron/blob/master/development.md#get-zulip-electron-code)
110+
Now you are ready for next step [: Get Zulip Desktop Code.](https://github.com/zulip/zulip-desktop/blob/master/development.md#get-zulip-desktop-code)
111111

112112

113-
# Get Zulip Electron Code
113+
# Get Zulip Desktop Code
114114

115-
1. In your browser, visit https://github.com/zulip/zulip-electron and click the `fork` button. You will need to be logged in to GitHub to do this.
115+
1. In your browser, visit https://github.com/zulip/zulip-desktop and click the `fork` button. You will need to be logged in to GitHub to do this.
116116
2. Open Terminal (macOS/Ubuntu) or Git BASH (Windows; must **run as an Administrator**).
117-
3. In Terminal/Git BASH, [clone your fork of the zulip-electron repository](https://github.com/zulip/zulip-electron/blob/master/development.md#clone-to-your-machine) and [connect the zulip-electron upstream repository](https://github.com/zulip/zulip-electron/blob/master/development.md#connect-your-fork-to-zulip-electron-upstream)
117+
3. In Terminal/Git BASH, [clone your fork of the zulip-desktop repository](https://github.com/zulip/zulip-desktop/blob/master/development.md#clone-to-your-machine) and [connect the zulip-desktop upstream repository](https://github.com/zulip/zulip-desktop/blob/master/development.md#connect-your-fork-to-zulip-desktop-upstream)
118118

119119

120120
## Clone to your machine
@@ -123,15 +123,15 @@ Now you are ready for next step [: Get Zulip Electron Code.](https://github.com/
123123
3. In the Clone with HTTPs section, click to copy the clone URL for the repository.
124124
4. Open Terminal, Change the current working directory to the location where you want the cloned directory to be made.
125125

126-
git clone https://github.com/YOURUSERNAME/zulip-electron.git
126+
git clone https://github.com/YOURUSERNAME/zulip-desktop.git
127127

128128
Don’t forget to replace YOURUSERNAME with your git username
129129

130130

131-
## Connect your fork to zulip-electron upstream
131+
## Connect your fork to zulip-desktop upstream
132132

133-
cd zulip-electron
134-
git remote add -f upstream https://github.com/zulip/zulip-electron.git
133+
cd zulip-desktop
134+
git remote add -f upstream https://github.com/zulip/zulip-desktop.git
135135

136136

137137
# build and run
@@ -145,7 +145,7 @@ Don’t forget to replace YOURUSERNAME with your git username
145145

146146
**vanilla method**
147147

148-
$ npm start
148+
$ npm start
149149

150150
**start and watch changes recommended for dev’s**
151151

‎docs/Windows.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ C:\Windows\system32> npm install --global --production windows-build-tools
2121
Clone the source locally:
2222

2323
```sh
24-
$ git clone https://github.com/zulip/zulip-electron
25-
$ cd zulip-electron
24+
$ git clone https://github.com/zulip/zulip-desktop
25+
$ cd zulip-desktop
2626
```
2727

2828
Install project dependencies:

‎docs/_Footer.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
### Want to contribute to this Wiki?
22

3-
[Edit `/docs` files and send a pull request.](https://github.com/zulip/zulip-electron/tree/master/docs)
3+
[Edit `/docs` files and send a pull request.](https://github.com/zulip/zulip-desktop/tree/master/docs)

0 commit comments

Comments
 (0)