Veil-Project / Veil-Link-Client

Veil LINK Client

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Veil X

A reimagined wallet experience for the pioneering privacy coin.
https://veil-project.com

Latest Release


⚠️ This is BETA software and may have serious bugs. It is only intended for beta testers and must not be used with live data. USE AT YOUR OWN RISK

Cross platform Veil wallet interface focused on user experience and ease of use.
The UI for Veil X is created using Electron + React + Overmind + Tailwind CSS.

Table of Contents

Install

Download the [latest release][releases] for your appropriate OS and follow the instructions below.

macOS

Once you have the .zip file downloaded, simply double click on the file to unzip.

Navigate to the newly extracted folder, then drag-and-drop the Veil X.app file to the Applications folder.

Finally, double click on the Veil X.app file.

Windows

Once you have the .exe file downloaded, simply double click on the file.

Linux

Once you have the .AppImage file downloaded you must make the file executable.

Once executible you can run either double click the file or run via the cli:

./file.AppImage

Get Help

If you are having problems with Veil X, please report the issue in GitHub or on Discord with screenshots and/or how to reproduce the bug/error.

Develop

Prerequisites

You’ll need to have Node >= 8.10 and npm >= 5.6 on your machine.

Running the app

Clone the repo, install dependencies, and run the app with yarn dev. This will start a development server with hot reload as well as run the Electron app with the right configuration.

Please note that only the client-side code is recompiled automatically. If you modify code on the Electron-side, you currently need to restart the dev server. This is due to the code being written in TypeScript which requires a complication step.

Create React App

Most of the webpack and build configuration is abstracted away thanks to Create React App.

State management

The application uses Overmind for state management. For the best experience you should install the Overmind Devtools extension which allows state inspection and action debugging.

Local database

For optimal performance, transaction details are cached in an IndexedDB database. Dexie is used as a thin convenience wrapper over the otherwise unwieldy IndexedDB API.

Styling

There's virtually no custom CSS code in the whole app, relying instead on Tailwind CSS—a highly customizable, low-level CSS framework that enables making a consistent UI with a small set of building blocks. The color ranges, spacing, typography and more are configured in tailwind.config.js.

Release

  1. Bump version in package.json
  2. yarn package-all
  3. Due to an open issue in electron-builder the Mac version requires manual tweaking as described here
  4. Upload release artifacts to a new Github release (when the above issue has been resolved, this can be automated).

Security

If you discover or learn about a potential error, weakness, or threat that can compromise the security of Veil X, we ask you to keep it confidential and submit your concern directly to the Veil security team.

Community

Join the Veil Discord

About

Veil LINK Client


Languages

Language:CSS 79.7%Language:TypeScript 17.9%Language:JavaScript 2.2%Language:HTML 0.1%