This repository has been archived by the owner on Jan 30, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
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
2 changed files
with
63 additions
and
62 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 |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
|  | ||
|
|
||
| # Installation | ||
|
|
||
| 👉 Install the released Iron Fish Node App by getting started [here](https://ironfish.network/use/node-app). Direct download links are available on [Github](https://github.com/iron-fish/node-app/releases/latest). | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Windows | ||
|
|
||
| **Q: The app crashes on launch with `A JavaScript error occurred in the main process. Error: The specified module could not be found`** | ||
|
|
||
| **A:** Install the Visual C++ Redistributable: https://aka.ms/vs/17/release/vc_redist.x64.exe | ||
|
|
||
| # Contributing | ||
|
|
||
| These instructions are for setting up the Node App in the case that you want to contribute to it. | ||
|
|
||
| ## Environment preparations | ||
|
|
||
| The following steps should only be used to install if you are planning on contributing to the Node app codebase. | ||
|
|
||
| 1. Install [Node.js 18.x](https://nodejs.org/en/download/) | ||
| 1. Install [Yarn](https://classic.yarnpkg.com/en/docs/install). | ||
| 1. Windows: | ||
|
|
||
| 1. Install the current version of Python from the [Microsoft Store package](https://www.microsoft.com/en-us/p/python-310/9pjpw5ldxlz5) or [Python website](https://www.python.org/ftp/python/3.11.1/python-3.11.1-amd64.exe). | ||
| 1. Install Visual C++ Build Environment: [Visual Studio Build Tools](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools) | ||
| (using "Visual C++ build tools" or "Desktop development with C++" workload) | ||
|
|
||
| If the above steps didn't work for you, please visit [Microsoft's Node.js Guidelines for Windows](https://github.com/Microsoft/nodejs-guidelines/blob/master/windows-environment.md#compiling-native-addon-modules) for additional tips. | ||
|
|
||
| 1. Run `yarn install` from the root directory to install packages. | ||
|
|
||
| #### Other platforms might require additional actions: See [Iron Fish Developer Install section](https://github.com/iron-fish/ironfish#developer-install) | ||
|
|
||
| ### Usage | ||
|
|
||
| Once your environment is set up it's possible to run the app: | ||
|
|
||
| Use `yarn start` or `yarn start:<mode>` to run app. | ||
| By default `dev` mode is used, also `demo` and `production` modes are available. | ||
|
|
||
| To test build use `yarn build`, there are also 3 modes for build: `demo`, `dev`, and `production`. `dev` is the default mode. | ||
|
|
||
| # Create application | ||
|
|
||
| Just run `yarn package` and executable files will be built and placed into the `./out` folder. | ||
|
|
||
| On macOS, the packaged .app file won't run without codesigning, but you can codesign it by running `codesign --force --deep -s - ./out/Iron Fish Node App.app`. | ||
|
|
||
| By default `demo` mode is used for creating the package. Use `production` mode to create a release version (`yarn package:production`). | ||
|
|
||
| # Releases | ||
|
|
||
| Releases are based on tags. In order to create a new release:, | ||
|
|
||
| Update `package.json` version, submit a PR and merge it to the `master` branch. | ||
|
|
||
| Run `git tag -a "vX.Y.Z" -m "vX.Y.Z"` where `X.Y.Z` is the major.minor.patch version (for demo version release, use `demo-v` prefix instead of `v`). | ||
|
|
||
| Run `git push --tags` |
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,64 +1,3 @@ | ||
| # Iron Fish Node App | ||
|
|
||
|  | ||
|
|
||
| # Installation | ||
|
|
||
| 👉 Install the released Iron Fish Node App by getting started [here](https://ironfish.network/use/node-app). Direct download links are available on [Github](https://github.com/iron-fish/node-app/releases/latest). | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Windows | ||
|
|
||
| **Q: The app crashes on launch with `A JavaScript error occurred in the main process. Error: The specified module could not be found`** | ||
|
|
||
| **A:** Install the Visual C++ Redistributable: https://aka.ms/vs/17/release/vc_redist.x64.exe | ||
|
|
||
| # Contributing | ||
|
|
||
| These instructions are for setting up the Node App in the case that you want to contribute to it. | ||
|
|
||
| ## Environment preparations | ||
|
|
||
| The following steps should only be used to install if you are planning on contributing to the Node app codebase. | ||
|
|
||
| 1. Install [Node.js 18.x](https://nodejs.org/en/download/) | ||
| 1. Install [Yarn](https://classic.yarnpkg.com/en/docs/install). | ||
| 1. Windows: | ||
|
|
||
| 1. Install the current version of Python from the [Microsoft Store package](https://www.microsoft.com/en-us/p/python-310/9pjpw5ldxlz5) or [Python website](https://www.python.org/ftp/python/3.11.1/python-3.11.1-amd64.exe). | ||
| 1. Install Visual C++ Build Environment: [Visual Studio Build Tools](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools) | ||
| (using "Visual C++ build tools" or "Desktop development with C++" workload) | ||
|
|
||
| If the above steps didn't work for you, please visit [Microsoft's Node.js Guidelines for Windows](https://github.com/Microsoft/nodejs-guidelines/blob/master/windows-environment.md#compiling-native-addon-modules) for additional tips. | ||
|
|
||
| 1. Run `yarn install` from the root directory to install packages. | ||
|
|
||
| #### Other platforms might require additional actions: See [Iron Fish Developer Install section](https://github.com/iron-fish/ironfish#developer-install) | ||
|
|
||
| ### Usage | ||
|
|
||
| Once your environment is set up it's possible to run the app: | ||
|
|
||
| Use `yarn start` or `yarn start:<mode>` to run app. | ||
| By default `dev` mode is used, also `demo` and `production` modes are available. | ||
|
|
||
| To test build use `yarn build`, there are also 3 modes for build: `demo`, `dev`, and `production`. `dev` is the default mode. | ||
|
|
||
| # Create application | ||
|
|
||
| Just run `yarn package` and executable files will be built and placed into the `./out` folder. | ||
|
|
||
| On macOS, the packaged .app file won't run without codesigning, but you can codesign it by running `codesign --force --deep -s - ./out/Iron Fish Node App.app`. | ||
|
|
||
| By default `demo` mode is used for creating the package. Use `production` mode to create a release version (`yarn package:production`). | ||
|
|
||
| # Releases | ||
|
|
||
| Releases are based on tags. In order to create a new release:, | ||
|
|
||
| Update `package.json` version, submit a PR and merge it to the `master` branch. | ||
|
|
||
| Run `git tag -a "vX.Y.Z" -m "vX.Y.Z"` where `X.Y.Z` is the major.minor.patch version (for demo version release, use `demo-v` prefix instead of `v`). | ||
|
|
||
| Run `git push --tags` | ||
| ### This version of the app is no longer under development. The repository for the new version of the app is here: 👉 https://github.com/iron-fish/ironfish-node-app |