Skip to content

Commit ab03474

Browse files
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 hyperledger-cacti#874 Signed-off-by: bado <[email protected]>
1 parent 6af5fda commit ab03474

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

BUILD.md

+39
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
- [Hyperledger Cacti Build Instructions](#hyperledger-cacti-build-instructions)
22
- [Fast Developer Flow / Code Iterations](#fast-developer-flow--code-iterations)
33
- [Getting Started](#getting-started)
4+
- [Quickstart with VSC Devcontainer for Hyperledger Cactus](#quickstart-with-vsc-devcontainer-for-hyperledger-cactus)
45
- [MacOS](#macos)
56
- [Linux](#linux)
67
- [Windows](#windows)
@@ -40,6 +41,44 @@ The `npm run watch` script in action:
4041

4142
## Getting Started
4243

44+
### Quickstart with VSC Devcontainer for Hyperledger Cactus
45+
46+
* Opening the repo Within a Docker Container
47+
* Install Prerequisites:
48+
* Visual Studio Code (VSC)
49+
* Docker Desktop (ensure it's running) https://docs.docker.com/desktop/setup/install/windows-install/
50+
* The Remote - Containers VSC extension
51+
* Clone the Repository:
52+
```
53+
git clone https://github.com/hyperledger-cacti/cacti.git
54+
cd cacti
55+
```
56+
* Open in VSC and Reopen in Container:
57+
* Launch VSC
58+
* Open the cacti folder
59+
* Press F1 and type and click "Dev Containers: Open Folder in Container."
60+
* Wait for the Container Setup:
61+
* The devcontainer will install all required dependencies inside the container.
62+
* Start Developing:
63+
* The container will have all necessary dependencies pre-installed.
64+
65+
* (This is optional) Cloning the repo to a Docker Volume
66+
* Clone the Repo Using Docker Volume:
67+
```
68+
docker volume create cacti_volume
69+
docker run -v cacti_volume:/workspace -w /workspace -it node:18.19.0 bash
70+
git clone https://github.com/hyperledger-cacti/cacti.git
71+
```
72+
* Attach VSC to the Running Container:
73+
* Open VSC.
74+
* Press F1 and type and click "Dev Containers: Open Folder in Container."
75+
* Choose the container created earlier.
76+
* Start Developing:
77+
* The container will have all necessary dependencies pre-installed.
78+
79+
_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_
80+
81+
4382
### MacOS
4483
4584
_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._

0 commit comments

Comments
 (0)