Skip to content

Commit

Permalink
docs(vscode): high level devcontainer quickstart documentation
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
zondervancalvez committed Jan 28, 2025
1 parent 6af5fda commit 5737283
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -40,6 +41,42 @@ 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:latest 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.
### 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._
Expand Down

0 comments on commit 5737283

Please sign in to comment.