|
1 | | -# Advanced Rest Client Application |
2 | | -================= |
| 1 | +--- |
| 2 | +description: Installation process for the Advanced REST Client application. |
| 3 | +--- |
3 | 4 |
|
4 | | -Welcome to the ARC's project repository. Please, read [.github/CONTRIBUTING.md](.github/CONTRIBUTING.md) and [ROADMAP.md](ROADMAP.md) files for more information. |
| 5 | +# Installing Advanced REST Client |
5 | 6 |
|
6 | | -## Development |
| 7 | +## Installing Advanced REST Client |
7 | 8 |
|
8 | | -You are welcome to contribute to the project. To start developing use following instructions. |
| 9 | +In most cases you can download the app from [https://github.com/advanced-rest-client/arc-electron/releases](https://github.com/advanced-rest-client/arc-electron/releases) |
9 | 10 |
|
10 | | -I assume you have [Node.js][1] already installed on your machine. |
| 11 | +Find an installer for your platform under "Assets" section. |
11 | 12 |
|
12 | | -Start with forking the repository and getting the code |
| 13 | + |
13 | 14 |
|
14 | | -```shell |
15 | | -git clone https://github.com/[your username]/arc-electron.git |
16 | | -``` |
| 15 | +For example, for Windows you would download `arc-setup.exe`. For MacOS download `arc-13.0.7.dmg`. |
17 | 16 |
|
18 | | -If you're not planing to contribute (you will not send a pull request) you can clone this repository: |
| 17 | +{% hint style="info" %} |
| 18 | + Version number may be different to the one in the scree shoot. For normal use, please, download latest stable version. |
| 19 | +{% endhint %} |
19 | 20 |
|
20 | | -```shell |
21 | | -git clone https://github.com/advanced-rest-client/arc-electron |
22 | | -``` |
| 21 | +When downloaded, run the file. The installed will walk you through the installation process. |
23 | 22 |
|
24 | | -When ready go to the directory: |
| 23 | +## Linux installation |
25 | 24 |
|
26 | | -```shell |
27 | | -cd arc-electron |
28 | | -``` |
| 25 | +ARC's build process generates several builds for Linux. Find your platform and then architecture. Wrong architecture \(x86 instead of x64\) will result with error when installing or running the application. |
29 | 26 |
|
30 | | -Then install dependencies: |
| 27 | +Please note that ARC won't update automatically on Linux platform as this is not yet supported by the build library. This may be possible in the future. |
31 | 28 |
|
32 | | -```shell |
33 | | -npm install && npm run bower |
34 | | -``` |
35 | 29 |
|
36 | | -When all dependencies are installed run: |
37 | 30 |
|
38 | | -```shell |
39 | | -npm start |
40 | | -``` |
41 | | - |
42 | | -New application window is now opened. |
43 | | - |
44 | | - |
45 | | -Thanks for testing and don't forget to file an issue report if you find a bug. |
46 | | -You are also welcome to send a pull request with bug fixes. Please, read [.github/CONTRIBUTING.md](.github/CONTRIBUTING.md) file first. |
47 | | - |
48 | | -## App design docs for developers |
49 | | -Please, read wiki in this repository. |
50 | | - |
51 | | - |
52 | | - [1]: https://docs.npmjs.com/getting-started/installing-node "Install Node.js" |
0 commit comments