From ab0347401885c41cbe8fba9a6765ad7a76f5f480 Mon Sep 17 00:00:00 2001 From: bado Date: Wed, 15 Jan 2025 23:57:14 +0800 Subject: [PATCH] docs(vscode): high level devcontainer quickstart documentation Primary Changes ---------------- 1. Added a documentation describing how to get started by opening the repo within the docker container and by cloning the repo to a docker volume Fixes #874 Signed-off-by: bado --- BUILD.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/BUILD.md b/BUILD.md index e5a20811c6..ce205a553d 100644 --- a/BUILD.md +++ b/BUILD.md @@ -1,6 +1,7 @@ - [Hyperledger Cacti Build Instructions](#hyperledger-cacti-build-instructions) - [Fast Developer Flow / Code Iterations](#fast-developer-flow--code-iterations) - [Getting Started](#getting-started) + - [Quickstart with VSC Devcontainer for Hyperledger Cactus](#quickstart-with-vsc-devcontainer-for-hyperledger-cactus) - [MacOS](#macos) - [Linux](#linux) - [Windows](#windows) @@ -40,6 +41,44 @@ The `npm run watch` script in action: ## Getting Started +### Quickstart with VSC Devcontainer for Hyperledger Cactus + +* Opening the repo Within a Docker Container + * Install Prerequisites: + * Visual Studio Code (VSC) + * Docker Desktop (ensure it's running) https://docs.docker.com/desktop/setup/install/windows-install/ + * The Remote - Containers VSC extension + * Clone the Repository: + ``` + git clone https://github.com/hyperledger-cacti/cacti.git + cd cacti + ``` + * Open in VSC and Reopen in Container: + * Launch VSC + * Open the cacti folder + * Press F1 and type and click "Dev Containers: Open Folder in Container." + * Wait for the Container Setup: + * The devcontainer will install all required dependencies inside the container. + * Start Developing: + * The container will have all necessary dependencies pre-installed. + +* (This is optional) Cloning the repo to a Docker Volume + * Clone the Repo Using Docker Volume: + ``` + docker volume create cacti_volume + docker run -v cacti_volume:/workspace -w /workspace -it node:18.19.0 bash + git clone https://github.com/hyperledger-cacti/cacti.git + ``` + * Attach VSC to the Running Container: + * Open VSC. + * Press F1 and type and click "Dev Containers: Open Folder in Container." + * Choose the container created earlier. + * Start Developing: + * The container will have all necessary dependencies pre-installed. + + _Optional: You can see an option on the bottom right part of the VSC window saying to Install the recommended extensions. Agreeing to that will install the optional extensions which will streamline the development process_ + + ### MacOS _Unless explicitly stated otherwise, each bullet will apply to both Intel and ARM Macs. In bullets where there is a difference in the installation process it will be noted._