From 8697f36a3dfab7de06456da15329e1e29273d10b Mon Sep 17 00:00:00 2001 From: ashnashahgrover Date: Thu, 18 Jul 2024 12:40:15 +0530 Subject: [PATCH] docs(build): add text build steps for Linux, Mac and Windows Primary Changes ---------------- 1. Updated BUILD.md to include Mac OS specific installation instructions. Fixes #1963 Signed-off-by: ashnashahgrover --- BUILD.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/BUILD.md b/BUILD.md index 525eb86ccd4..097ce5f0d26 100644 --- a/BUILD.md +++ b/BUILD.md @@ -2,6 +2,7 @@ - [Fast Developer Flow / Code Iterations](#fast-developer-flow--code-iterations) - [Getting Started](#getting-started) - [Random Windows specific issues not covered here](#random-windows-specific-issues-not-covered-here) + - [MacOS specific instructions] (#MacOS-specific-instructions) - [Build Script Decision Tree](#build-script-decision-tree) - [Configuring SSH to use upterm](#configuring-ssh-to-use-upterm) @@ -154,6 +155,30 @@ At this point, with the running API server, you can We recommend that you use WSL2 or any Linux VM (or bare metal). We test most frequently on Ubuntu 20.04 LTS +#### MacOS specific instructions +* Use preset environment: + * [VSCode docker container](./.devcontainer) +* ... or install OS level dependencies manually: + * Git + * https://github.com/git-guides/install-git#install-git-on-mac + * NodeJS v18.19.0, npm v10.2.3 (we recommend using the Node Version Manager (nvm) if available for your OS) + ``` + nvm install 18.19.0 + nvm use 18.19.0 + ``` + * Yarn + * `npm run enable-corepack` (from within the project directory) + * [Docker Engine is available on Mac OS through Docker Engine](https://docs.docker.com/desktop/install/mac-install/). + * Docker Compose + * Installing Docker Desktop on Mac will include Docker Compose + * OpenJDK (Corda support Java 8 JDK but do not currently support Java 9 or higher) + * [Follow instructions for Mac here](https://github.com/supertokens/supertokens-core/wiki/Installing-OpenJDK-for-Mac-and-Linux) + * Indy SDK (optional) + * [Build the SDK from source](https://github.com/hyperledger-archives/indy-sdk/blob/main/docs/build-guides/mac-build.md) + * Go + * [Installing Go](https://go.dev/) + * [Adding Environment Variable and Go extensions](https://code.visualstudio.com/docs/languages/go) + ## Build Script Decision Tree The `npm run watch` script should cover 99% of the cases when it comes to working