- Nault - The main wallet application (UI + Seed Generation/Block Signing/Etc).
- Communication with the network is done via nano RPC and Websocket protocols, private or public on any nano network.
- NodeJS v16.x + NPM v8.x
- Angular CLI:
npm install -g @angular/cli
git clone https://github.com/Nault/Nault
cd Nault
npm install
npm run wallet:dev
If you want to debug in VS code, first install debugger for chrome Then you can just go to the debug screen and choose "Launch Chrome http"
npm run wallet:dev-ssl
To debug in VS code: Go to debug screen and choose "Launch Chrome https"
Build a production version of the wallet for web:
npm run wallet:build
Build a production version of the wallet for desktop: (Required for the desktop builds below)
npm run wallet:build-desktop
All desktop builds require that you have built a desktop version of the wallet before running!
Run the desktop wallet in dev mode:
npm run desktop:dev
If you want to debug in VS code, first install debugger for chrome Then you can just go to the debug screen and choose "Electron: Main", "Electron: Renderer", or "Electron: All" for both Main and Renderer threads.
Build the desktop wallet for your local OS (Will be in desktop-app\build
):
npm run desktop:local
Can also run a complete build for your local OS. The "wallet:build-desktop" command is run automatically. (Will be in desktop-app\build
):
npm run desktop:build-local
Build the desktop wallet for Windows+Mac+Linux (May require dependencies for your OS View them here):
npm run desktop:full
Run ng test
to execute the unit tests via Karma.
Run ng e2e
to execute the end-to-end tests via Protractor.
- Instead of and setting up manually, a new component can be added simply by running
ng g component components/component-name
from root folder - Similar, a service can be added by
ng g service services/service-name
and add it to the providers section in the app.module.ts
This will only be done by repo admins. It's dependent on github workflows so if you have forked the repo and want to test releases yourself, you must change the GITHUB_TOKEN in all workflow files to another key for example WORKFLOW. Then add this key to your repo secrets with writing rights. You also need to activate workflows because it's disabled by default when you fork.
- Bump new version (major, minor or patch). It will change the package.json version, commit and create a new tag:
npm version patch
- Push the new commit and tag to origin:
git push --follow-tags
- The github actions will take care of the rest. Linting, release draft, docker, desktop app building and uploading binaries based on the new version