evan/rats-search
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc(README): add desktop section

Browse Source
This commit is contained in:
Alexey Kasyanchuk 2021-07-14 15:10:51 +03:00
parent 9e3870ff44
commit f3e08b5aa4
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -45,6 +45,20 @@ We are welcome any contributing: bug fixes, improvements, code refactoring and o
* [English](docs/USAGE.md)
* [Russian](docs/USAGE.RU.md)
## Download Desktop client
By default we recomended using desktop version of application. [<b>Download and install most recent one</b>](https://github.com/DEgITx/rats-search/releases) for Windows, MacOS, Linux.
### Start desktop client from master branch
Clone repository, then make sure that you have Node.js and NPM (with Node.js) installed in your system, then install all needed packages:
```bash
npm install
```
and start master develop branch version:
```bash
npm start
```
## Server webUI version installation
Beside default desktop cross-platform client, also exist separated webUI that can run from server independant as web-client + Node.JS server.