Skip to content
This repository was archived by the owner on Jan 30, 2024. It is now read-only.

CONTRIBUTING.MD

Latest commit

 

History

History
62 lines (34 loc) · 2.92 KB

CONTRIBUTING.MD

File metadata and controls

62 lines (34 loc) · 2.92 KB

Build

Installation

👉 Install the released Iron Fish Node App by getting started here. Direct download links are available on Github.

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

  2. Install Yarn.

  3. Windows:

    1. Install the current version of Python from the Microsoft Store package or Python website.
    2. Install Visual C++ Build Environment: Visual Studio Build Tools (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 for additional tips.

  4. Run yarn install from the root directory to install packages.

Other platforms might require additional actions: See Iron Fish Developer Install section

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