Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(vscode): high level devcontainer quickstart documentation #3723

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 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,39 @@ 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/engine/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 Ctrl+Shift+P → Select Reopen in Container.
* Wait for the Container Setup:
* The devcontainer will install all required dependencies inside the container.
* 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 Ctrl+Shift+P → Select Remote-Containers: Attach to Running 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
Loading