Skip to content

Commit

Permalink
docs(build): add text build steps for Linux, Mac
Browse files Browse the repository at this point in the history
and Windows

Primary Changes
----------------
1. Updated BUILD.md to include Mac OS specific
installation instructions.

Fixes #1963

Signed-off-by: ashnashahgrover <as19@williams.edu>
  • Loading branch information
ashnashahgrover committed Jul 18, 2024
1 parent 497ea32 commit 8697f36
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 8697f36

Please sign in to comment.