docs(build): add text build steps for Linux, Mac and Windows #2072
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 |
|---|---|---|
| @@ -1,91 +1,84 @@ | ||
| ### Cactus BUILD instruction | ||
|
|
||
| #### Installing Git | ||
| Git is a tool for version control that you will need to build and maintain Hyperledger Cactus from source. To install Git on a Debian-based Linux system, you should run the following command. | ||
|
|
||
| ```shell | ||
| sudo apt install git-all | ||
| ``` | ||
|
|
||
| Installation methods for other systems can be found [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). | ||
|
|
||
| #### Installing Docker | ||
|
|
||
| Docker is a tool for containerization of softwares. It helps ship software and mitigates compatibility issues. To install Docker, please follow the installation guide provided [here](https://docs.docker.com/engine/install/). | ||
|
|
||
| To install Docker on Debian, one would follow the following steps. | ||
|
|
||
| ```shell= | ||
| ### Uninstall old Docker versions | ||
| sudo apt-get remove docker docker-engine docker.io containerd runc | ||
|
|
||
| ### Setup your repositories | ||
| sudo apt-get update | ||
| sudo apt-get install \ | ||
| ca-certificates \ | ||
| curl \ | ||
| gnupg \ | ||
| lsb-release | ||
|
|
||
| ### Add Docker's GPG keys | ||
| sudo mkdir -p /etc/apt/keyrings | ||
| curl -fsSL https://download.docker.com/linux/debian/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg | ||
| echo \ | ||
| "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian \ $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null | ||
|
|
||
| ### Install the Docker Engine | ||
| sudo apt-get update | ||
| sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin | ||
|
|
||
| ### Check that the package has been correctly installed | ||
| sudo docker run hello-world | ||
|
There was a problem hiding this comment. After this line, reference can also be given to use docker without sudo, as mentioned here, https://docs.docker.com/engine/install/linux-postinstall/ |
||
|
|
||
| ``` | ||
|
|
||
| #### Installing NPM and Node | ||
|
|
||
| NPM is Node Package Manager and essential to building Cactus. There are many different methods of installing Node depending on your system and thus it is recommended you follow the guide provided [here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). | ||
|
|
||
| ``` | ||
| sudo apt-get update | ||
| sudo apt install nodejs | ||
| sudo apt install npm | ||
| ``` | ||
|
|
||
| #### Installing JDK 8 | ||
|
|
||
| ``` | ||
| sudo apt-get update | ||
| sudo apt-get install openjdk-8-jdk | ||
|
|
||
| ### Check the version of Java | ||
| java -version | ||
|
|
||
| ### If you're using bash, you may need to set this in your bashrc file | ||
| export JAVA_HOME=<path_to_java_home> | ||
| ``` | ||
|
|
||
| #### Installing VS Code | ||
|
|
||
| You can download and install VS Code from [here](https://code.visualstudio.com/download). It is suggested to install the git-graph and Docker plugins. | ||
|
There was a problem hiding this comment. Here, we can also mention the |
||
|
|
||
| #### Clone and compile the Cactus repository 🌵 | ||
|
|
||
| ``` | ||
| git clone https://github.com/hyperledger/cactus | ||
| npm install | ||
| npm run configure | ||
|
|
||
| ### To test all your packages, you can run | ||
| npm run test:all | ||
| ``` | ||
|
|
||
| ## Getting Started | ||
|
|
||
|
|
@@ -232,4 +225,4 @@ By creating a PR for the edited `ci.yml` file, this will the CI to run their tes | |
| 1) Go to the PR and click the `checks` tab | ||
| 2) Go to the `Actions` tab within the main Hyperledger Cactus Repository | ||
|
|
||
| Click on the `CI Cactus workflow`. There should be a new job you've created be listed underneath the `build (ubuntu-20.04)` jobs. Click on the the new job (what's you've named your build) and locate the SSH Session within the `Setup Upterm Session` dropdown. Copy the SSH command that start with `ssh` and ends in `.dev` (ex. ssh **********:***********@uptermd.upterm.dev). Open your OS and paste the SSH command script in order to begin an upterm session. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe saying Hyperledger Cactus (instead of just Cactus) here is better.