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

https://github.com/golemfactory/golem-electron-dev

Develop version of golem-electron
https://github.com/golemfactory/golem-electron-dev

Last synced: 3 months ago
JSON representation

Develop version of golem-electron

Awesome Lists containing this project

README

          

# Golem Electron Application
![Minimum Node Requirement](https://img.shields.io/badge/node-%3E%3D6.14.0-brightgreen.svg)
[![CircleCI](https://circleci.com/gh/golemfactory/golem-electron.svg?style=shield)](https://circleci.com/gh/golemfactory/golem-electron)






The desktop application using Electron, React and Redux.

## Development
### :wrench: Installation
Go to project main folder and hit;
```
npm install
```
or if you wish;
```
yarn
```
That's it!

### :computer: Usage
Start dev server
```
npm run start:app
```

Start electron application on testnet (development mode)
```
npm run start
```

Start electron application on mainnet (development mode)
```
npm run start:mainnet
```
### :bug: Debug mode
While using application, you can choose `Debug mode` from the `View` menu or press;

Windows:  
Ctrl + Shift + L


Mac:          
⌘ cmd + Shift + L


Linux:        
Ctrl + Shift + L




Debug mode will be activated.


Now you can restart the application to catch all critical informations from beginning.




You'll find debug logs in;



|OS|Path|General Log|Error Log|
|---|---|---|---|
|Windows|`%LOCALAPPDATA%\golem\golem\default\{CURRENT_CHAIN}\logs\`|`gui.log`|`gui-error.log`|
|Mac|`~/Library/Application\ Support/golem/default/{CURRENT_CHAIN}/logs/`|`gui.log`|`gui-error.log`|
|Linux|`~/.local/share/golem/default/{CURRENT_CHAIN}/logs/gui.log/`|`gui.log`|`gui-error.log`|



Note: `{CURRENT_CHAIN}` parameter will be `mainnet` if you running golem on mainnet, if you're on testnet it will be `rinkeby` in this case.


### :control_knobs: Developer mode
While using application, you can choose `Developer mode` from the `View` menu or press;

Windows:  
Ctrl + Shift + D


Mac:          
⌘ cmd + Shift + D


Linux:        
Ctrl + Shift + D




Developer mode will be activated.



You'll find additional information about;
- subtask node list in task details page
- peer list in settings tab
- stats about the application in settings tab
- more detailed tooltip information while hovering subtask borders in preview window

### :umbrella: Testing
Run tests
``` js
npm run test
npm run test:watch //live
npm run test:coverage //live
```