-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
21 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,36 @@ | ||
| # kaspa-ng | ||
|
|
||
| ## Destop p2p node and wallet for Kaspa built on top of [Rusty Kaspa](https://github.com/kaspanet/rusty-kaspa) core framework | ||
| _ALPHA RELEASE - This project is work in progress and and has been pre-released for testing purposes only._ | ||
| _It is not intended for production use at this time._ | ||
|
|
||
| ## Building | ||
| ### Desktop p2p node and wallet for the Kaspa Network | ||
|
|
||
| For prerequisites, please follow the Rusty Kaspa [build instructions](https://github.com/kaspanet/rusty-kaspa#getting-started). | ||
| This project is built on top of an incorporates the [Rusty Kaspa](https://github.com/kaspanet/rusty-kaspa) core framework. | ||
|
|
||
| ## Running Native | ||
| ``` | ||
| ### Building | ||
|
|
||
| To build this project, you need to be able to build Rusty Kaspa. If you have not built Rusty Kaspa before, please follow the Rusty Kaspa [build instructions](https://github.com/kaspanet/rusty-kaspa/blob/master/README.md). | ||
|
|
||
| Once you have Rusty Kaspa built, you will be able to build and run this project as follows: | ||
|
|
||
| #### Running as Native App | ||
| ```bash | ||
| cargo run --release | ||
| ``` | ||
|
|
||
| ## Running Web | ||
| ``` | ||
| #### Running as Web App | ||
| ```bash | ||
| cargo install trunk | ||
| trunk serve | ||
| trunk serve --release | ||
| ``` | ||
| Access via [https://localhost:8080](https://localhost:8080) | ||
|
|
||
| ## Browser Extension | ||
| While the application is a static serve, you can not load it from the local file system due to CORS restrictions. Due to this, a web server is required. This application is designed to be built with [Trunk](https://trunkrs.dev/) and is served from the `dist/` folder. This is a self-contained client-side application: once the application is loaded, the web server is no longer required. | ||
|
|
||
| This project currently supports Chrome browser extension target, but this component of the project is under heavy development and is not ready for use. | ||
| ``` | ||
| #### Running as a Browser Extension | ||
|
|
||
| This project currently supports Chrome browser extension target, but this part of the project is under development and is not ready for use. | ||
|
|
||
| ```bash | ||
| ./build-chrome | ||
| ``` | ||
|
|
||
| <details> | ||
| <summary>Windows x64</summary> | ||
| Windows build instructions | ||
| </details> | ||
| <details> | ||
| <summary>Linux</summary> | ||
| Linux build instructions | ||
| </details> | ||
| <details> | ||
| <summary>Mac OS</summary> | ||
| Mac OS build instructions | ||
| </details> |