refactor: improve the example setup (#62)

This commit adds a new `prepare_examples` alias to the dev container
that users can use to setup all the dependencies for the examples. It
also updates the documentation.

Author: rickstaa

.devcontainer/README.md

@@ -65,8 +65,54 @@ Replace `/path/to/your/model-files` and `path/to/your/output-files` with the pat
 2. From VS Code, reload the folder as a devcontainer:
    - Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on macOS).
    - Select `Remote-Containers: Reopen in Container`.
+3. Wait for the container to build and start.
 
-### Download models
+### Starting ComfyUI
+
+Start ComfyUI:
+
+```sh
+cd /workspace/comfystream/ComfyUI
+conda activate comfyui
+python main.py --listen
+```
+
+When using TensorRT engine enabled workflows, you should include the `---disable-cuda-malloc` flag as shown below:
+
+```sh
+cd /workspace/comfystream/ComfyUI
+conda activate comfyui
+python main.py --listen --disable-cuda-malloc
+```
+
+### Starting ComfyStream
+
+Start ComfyStream:
+
+```sh
+cd /workspace/comfystream
+conda activate comfystream
+python server/app.py --workspace /workspace/ComfyUI --media-ports=5678 --host=0.0.0.0 --port 8889
+```
+
+Optionally, you can also start the [ComfyStream UI](../README.md#run-ui) to view the stream:
+
+```sh
+cd /workspace/comfystream/ui
+npm run dev:https
+```
+
+### Running Example Workflows
+
+To run example workflows, you need to download models and build TensorRT engines. You can do this from within the dev container by running the following command in the terminal:
+
+```sh
+prepare_examples
+```
+
+Alternatively, you can follow the steps below.
+
+#### Download models
 
 From within the **dev container**, download models to run the example workflows:
 
@@ -80,7 +126,7 @@ For more info about configuring model downloads, see [src/comfystream/scripts/RE
 
 By following these steps, you should be able to set up and run your development container for ComfyStream efficiently.
 
-### Building the DepthAnything Engine
+#### Building the DepthAnything Engine
 
 After downloading models, it is necessary to compile TensorRT engines for the example workflow.
 
@@ -113,40 +159,6 @@ Alternatively, you may activate an environment manually with `conda activate com
 
 > [!NOTE] For more information, see [Python environments in VS Code](https://code.visualstudio.com/docs/python/environments)
 
-### Starting ComfyUI
-
-Start ComfyUI:
-
-```sh
-cd /workspace/comfystream/ComfyUI
-conda activate comfyui
-python main.py --listen
-```
-
-When using TensorRT engine enabled workflows, you should include the `---disable-cuda-malloc` flag as shown below:
-
-```sh
-cd /workspace/comfystream/ComfyUI
-conda activate comfyui
-python main.py --listen --disable-cuda-malloc
-```
-
-### Starting ComfyStream
-
-Start ComfyStream:
-
-```sh
-cd /workspace/comfystream
-conda activate comfystream
-python server/app.py --workspace /workspace/ComfyUI --media-ports=5678 --host=0.0.0.0 --port 8889
-```
-
-Optionally, you can also start the [ComfyStream UI](../README.md#run-ui) to view the stream:
-
-```sh
-cd /workspace/comfystream/ui
-npm run dev:https
-```
 
 ## Additional Resources
 

.devcontainer/post-create.sh

@@ -1,4 +1,8 @@
 #!/bin/bash
-
+chmod +x /workspace/comfystream/docker/entrypoint.sh
 cd /workspace/comfystream
-/bin/bash
+
+echo 'alias prepare_examples="/workspace/comfystream/docker/entrypoint.sh --download-models --build-engines"' >> ~/.bashrc
+echo -e "\e[32mContainer ready! Run 'prepare_examples' to download models and build engines for example workflows.\e[0m"
+
+/bin/bash