Skip to content

Latest commit

 

History

History
159 lines (107 loc) · 5.36 KB

README.md

File metadata and controls

159 lines (107 loc) · 5.36 KB
Raw

Phantom Desktop Wallet

Phantom Desktop Wallet

Build Status Latest Version License: MIT

Download

Latest Release

Installing via Package Managers

Arch Linux

Install via AUR:

Manjaro

pamac build phantom-desktop

Mac OS X

Install via Homebrew:

brew cask install phantom-desktop-wallet

Translations

Translations are part of our PHANTOM Development and Security Bounty Program.

Full translations are considered to be Tier 3, while grammar fixes, typos, etc. are considered to be Tier 6.

Full translations should involve 5 tasks
  • Create a pull request for the language you are going to translate. If you have doubts about something, use English to explain them.
  • Translate the textual content of the application, using the English language file as the reference. To do that, a new file, with the language locale code should be created. The name of the file should be a valid RFC 5646 and should be located at src/renderer/i18n/locales/LANGUAGE.js. Thanks to vue-i18n-extract, it is possible to execute yarn i18n src/renderer/i18n/locales/LANGUAGE.js to find suggestions of missing translations.
  • Add the language to the English language file at the LANGUAGES key.
  • Update the date and time formats file to include the short and long format that are used commonly by native speakers.
  • Update the number formats file to include the preferred way of displaying currencies used commonly by native speakers.
  • Add the language at the I18N.enabledLocales array at the main configuration file. This step is necessary to make the language available.
  • Execute the application. Go to the development section to learn how to install the requirements and execute it.

Development

Requirements

Ubuntu

In Ubuntu the development files of libudev are necessary:

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

Windows

  • Python 2.7
  • Visual Studio 2017

Node 11

To download, head over to here and download Node 11.

If you already have npm installed, you can run

npm install -g n
sudo n 11

Yarn

Install the Yarn dependency manager

npm install -g yarn

Commands

List of commands 
# Install dependencies
yarn install

# Execute the application. Making changes in the code, updates the application (hot reloading).
yarn dev

# Lint all JS/Vue files in the `src` and `__tests__`
yarn lint

# Lint, and fix, all JS/Vue files in `src` and `__tests__`
yarn lint:fix

# Check that all dependencies are used
yarn depcheck

# Collect the code and produce a compressed file
yarn pack

# Build electron application for production (Current OS)
yarn build

# Build electron application for production (Windows)
yarn build:win

# Build electron application for production (Mac)
yarn build:mac

# Build electron application for production (Linux)
yarn build:linux

# Run unit and end-to-end tests
yarn test

# Run unit tests
yarn test:unit

# Run unit tests and generate and display the coverage report
yarn test:unit:coverage

# Run unit tests and watch for changes to re-run the tests
yarn test:unit:watch

# Run end-to-end tests, without building the application
yarn test:e2e

# Build the application and run end-to-end tests
yarn test:e2e:full

# List what translations are missing or unused on a specific language. It could capture suggestions that are not accurate
yarn i18n 'src/renderer/i18n/locales/LANGUAGE.js'

# List what English messages are missing or unused (English is the default language)
yarn i18n:en-US

# List what translations are missing or unused on every language
yarn i18n:all

Security

If you discover a security vulnerability within this project, please send an e-mail to security@phantom.org. All security vulnerabilities will be promptly addressed.

Credits

License

MIT © PhantomChain