idena-network / idena-desktop

Idena Desktop client for Windows, Mac, and Linux
https://idena.io
MIT License
102 stars 67 forks source link

Idena Desktop

Idena Desktop client for Windows, Mac, and Linux.

Backed by Electron, React and Next.js.

Build Status dependencies Status devDependency Status

IMPORTANT!!!

We do not recommend to start the client with npm start for the validation session.

Please download and run the latest app version or use npm run dist for building and packaging the app on your own.

You can also check #112

Getting started

Download latest release

https://github.com/idena-network/idena-desktop/releases/latest

Install

Follow installation instructions for your system.

Get to know Idena

Visit Idena for the most common questions and guidelines.

Configuration

Most of the configuration is available in userData directory:

Note: Manual configuration is a danger zone that may corrupt your Idena installation and lead to unexpected behavior. Only edit configuration files if you're 💯sure what you do.

Logs

Logs are available in logs directory:

Built-in node

Node configuration and data files located in node directory inside userData:

The built-in node directory structure is the same as for standalone node.

Development

Prerequisites

Install dependencies

npm install

Run

npm start

Build

Builds available for macOS, Windows and Linux platforms thanks to electron-builder.

You may build for the current platform:

npm run dist

or for a specific platform

npm run dist:win
npm run dist:mac
npm run dist:linux

Currently, only deb target supported for Linux.

PRs are welcome! 👐

Contributing

Localization

Please check your language plurals here.