Skip to content

Commit f12dbab

Browse files
authored
Merge pull request #1914 from bougui/dev-setup
Dev setup precision to use devcontainer
2 parents ccb443e + 4509a84 commit f12dbab

9 files changed

+15
-499
lines changed

Diff for: README.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,9 @@ Indy Node repo consists of the following parts:
8989
- Some scripts that can be run for installed Node (in particular, scripts to start Nodes, generate keys, prepare test Network, etc.)
9090
- doc
9191
- A folder with documentation
92-
- dev-setup
93-
- A folder with scripts helping to configure development environment (python, dependencies, projects, virtual environment)
92+
- .devcontainer
93+
- A folder with scripts helping to configure a [development environment](#how-to-start-working-with-the-code). Please refer to the official [DevContainer documentation](https://containers.dev/) for more information.
94+
9495

9596
## Dependent Projects
9697

@@ -144,10 +145,19 @@ The described process is automated in one of the ways below (it allow to install
144145
- **Also coming soon:** Create virtual machines in AWS.
145146

146147

147-
148148
## How to Start Working with the Code
149149

150-
Please have a look at [Dev Setup](docs/source/setup-dev.md)
150+
The preferred method of setting up the development environment is to use the **devcontainers**.
151+
All configuration files for VSCode and [Gitpod](https://gitpod.io) are already placed in this repository.
152+
If you are new to the concept of devcontainers in combination with VSCode [here](https://code.visualstudio.com/docs/remote/containers) is a good article about it.
153+
154+
Simply clone this repository and VSCode will most likely ask you to open it in the devcontainer, if you have the correct extension("ms-vscode-remote.remote-containers") installed.
155+
If VSCode didn't ask to open it, open the command palette and use the `Remote-Containers: Rebuild and Reopen in Container` command.
156+
157+
If you want to use Gitpod simply use this [link](https://gitpod.io/#https://github.com/hyperledger/indy-node/tree/main)
158+
or if you want to work with your fork, prefix the entire URL of your branch with `gitpod.io/#` so that it looks like `https://gitpod.io/#https://github.com/hyperledger/indy-node/tree/main`.
159+
160+
**Note**: Be aware that the config files for Gitpod and VSCode are currently only used in the `main` branch!
151161

152162

153163
## Continuous Integration and Delivery

Diff for: dev-setup/osx/setup-dev-dependencies.sh

-44
This file was deleted.

Diff for: dev-setup/ubuntu/init-dev-project.sh

-40
This file was deleted.

Diff for: dev-setup/ubuntu/setup-dev-depend-ubuntu14.sh

-28
This file was deleted.

Diff for: dev-setup/ubuntu/setup-dev-depend-ubuntu16.sh

-39
This file was deleted.

Diff for: dev-setup/ubuntu/setup-dev-python.sh

-20
This file was deleted.

Diff for: dev-setup/ubuntu/ubuntu-2004/SetupVMTest.txt

-105
This file was deleted.

Diff for: docs/source/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Welcome to Hyperledger Indy Node's documentation!
2222
ci-cd.md
2323
indy-file-structure-guideline.md
2424
write-code-guideline.md
25-
setup-dev.md
25+
2626

2727

2828

0 commit comments

Comments
 (0)