How to build the Desktop Wallet from source?

Desktop Wallet version 2.x

The official ARK Desktop Wallet is an open-source, cross-platform and MIT-licensed project maintained by the ARK Team & Community.

It is an Electron-based JavaScript app developed with Vue.js & Tailwind CSS using the Node v12 runtime.

The ARK Desktop Wallet’s source code can be found at the following link: https://github.com/ArkEcosystem/desktop-wallet

Requirements

Ubuntu

Ubuntu requires additional libraries for kernel device management and hardware wallet support.

  • libudev-dev
  • libusb-1.0-0-dev

These may be installed using apt-get:

1sudo apt-get install libudev-dev libusb-1.0-0-dev

Windows

Windows additionally requires Python 2.7 and Visual Studio 2017.

They may be downloaded and installed via the links provided below:

Node 12

Node.js v12 is the supported runtime for the ARK Desktop Wallet.

Download and install the appropriate Node v12 package from: https://nodejs.org/dist/latest-v12.x

If npm is already installed, we may also run the following as an alternative:

1npm install -g n
2sudo n 12

https://nodejs.org

Yarn

The Yarn dependency manager is also required and may be installed globally using the following npm command:

1npm install -g yarn

https://yarnpkg.com

Commands

Below is a list of useful yarn commands for building, testing and packaging the ARK Desktop Wallet.

script reference
1# view `package.json` for more commands and details
2 
3# Install dependencies
4yarn install
5 
6# Run the application using hot-reloading
7yarn dev
8 
9# Lint all JS/Vue files in `src` and `__tests__`
10yarn lint
11 
12# Lint and fix all JS/Vue files in `src` and `__tests__`
13yarn lint:fix
14 
15# Create a compressed package of the collected code
16yarn pack
17 
18# Build the Electron app for production (using the Current OS)
19yarn build
20 
21# Build the Electron app for production (Windows)
22yarn build:win
23 
24# Build the Electron app for production (Mac)
25yarn build:mac
26 
27# Build the Electron app for production (Linux)
28yarn build:linux
29 
30# Run unit and end-to-end (e2e) tests
31yarn test
32 
33# Run unit tests
34yarn test:unit
35 
36# Run unit tests, then generate and display the coverage report
37yarn test:unit:coverage
38 
39# Run unit tests, then watch for changes before re-running tests
40yarn test:unit:watch
41 
42# Run end-to-end (e2e) tests without building the Electron app
43yarn test:e2e
44 
45# Build the Electron app, then run end-to-end (e2e) tests
46yarn test:e2e:full

hint: The most common command used to build from source to a live instance is: yarn install && yarn dev

Security

If you discover a security vulnerability within this package, please send an e-mail to [email protected]. All security vulnerabilities will be promptly addressed.

Credits

This project exists thanks to all the people who contribute .

License

MIT © ARK Ecosystem

Last updated 3 years ago
Edit Page
Share: