Skip to content

Commit

Permalink
chore(build.md): update documentation regarding deprecated scripts
Browse files Browse the repository at this point in the history
Primary Changes
---------------

1. Remove the Youtube video links from Cactus documentation
2. Added Go installation and updated node version
3. Checked for deprecated scripts in the md files

fixes: 1272

Signed-off-by: ruzell22 <[email protected]>
  • Loading branch information
ruzell22 authored and petermetz committed May 13, 2024
1 parent d9577b8 commit cf641c8
Showing 1 changed file with 14 additions and 64 deletions.
78 changes: 14 additions & 64 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Hyperledger Cactus Build Instructions
- [Hyperledger Cactus Build Instructions](#hyperledger-cactus-build-instructions)
- [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)
- [Build Script Decision Tree](#build-script-decision-tree)
- [Configuring SSH to use upterm](#configuring-ssh-to-use-upterm)

## Hyperledger Cactus Build Instructions

This is the place to start if you want to give Cactus a spin on your local
machine or if you are planning on contributing.
Expand All @@ -10,66 +17,6 @@ machine or if you are planning on contributing.
The project uses Typescript for both back-end and front-end components.

## Developers guide

This is a video guide to setup Hyperledger Cactus on your local machine.

### Installing git

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/RJhifrmSiNA/0.jpg)](https://www.youtube.com/watch?v=RJhifrmSiNA)

### Installing and configuring docker

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/V8YBQoxdyiE/0.jpg)](https://www.youtube.com/watch?v=V8YBQoxdyiE)

### Installing npm and node

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/94xoV9Vfu14/0.jpg)](https://www.youtube.com/watch?v=94xoV9Vfu14)

### Installing jdk 8

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/V8YBQoxdyiE/0.jpg)](https://youtube.com/watch?v=t4y57Qvrdcc)

### Installing VSCode and plugins

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/RHQLhZRlAR0/0.jpg)](https://www.youtube.com/watch?v=RHQLhZRlAR0)

### Clone the repository

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/n_HiEwgzPsM/0.jpg)](https://www.youtube.com/watch?v=n_HiEwgzPsM)

### Compiling all packages

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/5v82MAHPQmM/0.jpg)](https://www.youtube.com/watch?v=5v82MAHPQmM)

### Testing all packages

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/mVuk8txh-JE/0.jpg)](https://www.youtube.com/watch?v=mVuk8txh-JE)

### Compiling a specific packages

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/e7vkd9i-I4c/0.jpg)](https://www.youtube.com/watch?v=e7vkd9i-I4c)

### Testing a specific package

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/Jzw9JQZu6c8/0.jpg)](https://www.youtube.com/watch?v=Jzw9JQZu6c8)

### Package structure - OpenAPI

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/5uuRTc3X4MM/0.jpg)](https://www.youtube.com/watch?v=5uuRTc3X4MM)

### Package structure - Web Services

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/DAML56rx5yQ/0.jpg)](https://www.youtube.com/watch?v=DAML56rx5yQ)

### Package structure - Main and Factory Plugin class

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/w0bmkpge2Dw/0.jpg)](https://www.youtube.com/watch?v=w0bmkpge2Dw)

### Package structure - Test class

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/3XpBYhN-8qs/0.jpg)](https://www.youtube.com/watch?v=3XpBYhN-8qs)

## Fast Developer Flow / Code Iterations

We put a lot of thought and effort into making sure that fast developer iterations can be
Expand All @@ -94,10 +41,10 @@ The `npm run watch` script in action:
* Windows Only
* WSL2 or any virtual machine running Ubuntu 20.04 LTS
* Git
* NodeJS v18.18.2, npm v8.5.0 (we recommend using the Node Version Manager (nvm) if available for your OS)
* NodeJS v18.19.0, npm v10.2.3 (we recommend using the Node Version Manager (nvm) if available for your OS)
```
nvm install 18.18.2
nvm use 18.18.2
nvm install 18.19.0
nvm use 18.19.0
```
* Yarn
* `npm run enable-corepack` (from within the project directory)
Expand All @@ -108,6 +55,9 @@ The `npm run watch` script in action:
* Indy SDK (optional)
* [Installing the SDK](https://github.com/hyperledger/indy-sdk#installing-the-sdk)
* [Build the SDK from source](https://github.com/hyperledger/indy-sdk#how-to-build-indy-sdk-from-source)
* Go
* [Installing Go](https://go.dev/)
* [Adding Environment Variable and Go extensions](https://www.geeksforgeeks.org/how-to-install-golang-in-vscode/)
* Clone the repository
Expand Down

0 comments on commit cf641c8

Please sign in to comment.