Code Monkey home page Code Monkey logo

mikron-vault-web's Introduction

MikronWebWallet

MikronWebWallet is a fully client-side signing wallet for sending and receiving Mikron in your browser

MikronWebWallet Screenshot

MikronWebWallet is based on NanoVault.io


Table of Contents

Bugs/Feedback

If you run into any issues, please use the GitHub Issue Tracker or head over to our Discord Server!
We are continually improving and adding new features based on the feedback you provide, so please let your opinions be known!


Everything below is only for contributing to the development of MikronWebWallet

To use the web wallet, go to wallet.mikron.io


Application Structure

The application is broken into a few separate pieces:

  • Mikron-Vault-Web - The main wallet application (UI + Seed Generation/Block Signing/Etc).
  • Mikron-Vault-Server - Serves the Wallet UI and brokers public communication between the wallet and the Mikron node.
  • Mikron-Vault-WS - Websocket server that receives new blocks from the Mikron node and sends them in real time to the wallet ui.

Development Prerequisites

  • Node Package Manager: Install NPM
  • Angular CLI: npm install -g @angular/cli

Development Guide

Clone repository and install dependencies

git clone https://github.com/mikroncoin/mikron-vault-web
cd mikron-vault-web
npm install

Run the wallet in dev mode

npm run wallet:dev

Build Wallet (For Production)

Build a production version of the wallet for web:

npm run wallet:build

Build a production version of the wallet for desktop: (Required for all desktop builds)

npm run wallet:build-desktop

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Test Spec

See TestSpec

Language Selection

The selected UI language is based on several factors, in the given order of precedence. A setting is taken into account only if present, and represents one of the available languages.

  • Query param, if present. E.g. '?lang=en', to the opening page
  • Language selected in the menu and saved with the settings (in the local storage)
  • Language setting of the browser
  • The default English (en).

Steps for releasing a new version

  • Update version in package.json (2 places, version, buildVersion)
  • Commit
  • Tag, e.g. git tag v1.2.0
  • Push, Push tags
  • Build npm run wallet:build
  • Rename and tar resulting dist folder, e.g. mikton-vault-web.v1.2.0.tgz
  • On Github releases page, add tgz to release
  • Deploy release under prod web server

Acknowledgements

Special thanks to the following!

mikron-vault-web's People

Contributors

cronoh avatar optout21 avatar fu5ha avatar bkilshaw avatar catenocrypt avatar angular-cli avatar raksooo avatar renesq avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.