You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/develop.md
+8-3
Original file line number
Diff line number
Diff line change
@@ -11,15 +11,20 @@ Here are some options that provide a great developer experience:
11
11
- Build time for a 2-Core codespace is **~6m**. This is done infrequently and cached for convenience.
12
12
- Start time for a 2-Core codespace is **~2m**. This will pull the built codespace from cache when you need it.
13
13
-*Tip*: GitHub auto names the codespace but you can rename the codespace so that it is easier to identify later.
14
-
-**Local IDE**:
14
+
-**Local IDE (VSCode - Dev Containers)**:
15
15
- Ensure you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
16
16
- Ensure you have [Docker](https://docs.docker.com/get-docker/)
17
17
- Ensure you have [VSCode](https://code.visualstudio.com/)
18
18
- Install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
19
19
-`git clone` the codebase repository and open it in VSCode
20
20
- Use the `Dev Containers extension` to `Reopen in Container` (More info in the `Getting started` included with the extension)
21
-
22
-
You will know your environment has finished loading once you see a terminal open related to `Running postStartCommand` with a final message: `Done`.
21
+
- You will know your environment has finished loading once you see a terminal open related to `Running postStartCommand` with a final message: `Done. Press any key to close the terminal.`.
22
+
-**Local IDE (Docker Compose)**:
23
+
- Ensure you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
24
+
- Ensure you have [Docker](https://docs.docker.com/get-docker/)
25
+
-`git clone` the codebase repository and open it in VSCode
26
+
- Issue the following command in the terminal to build and run the Docker container: `HOST_UID=$(id -u) PY_VER=3.11 DJ_VERSION=$(grep -oP '\d+\.\d+\.\d+' datajoint/version.py) docker compose --profile test run --rm -it djtest -- sh -c 'pip install -qe ".[test]" && bash'`
27
+
- Issue the following command in the terminal to stop the Docker compose stack: `docker compose --profile test down`
0 commit comments