@@ -568,60 +568,81 @@ Need help? See:
568
568
569
569
---
570
570
571
- ## Quick Start ( VS Code Dev Container)
571
+ ## 🚀 Quick Start: VS Code Dev Container
572
572
573
- For the fastest development setup, use the provided VS Code Dev Container configuration. This provides a fully configured development environment with Python 3.11, Docker CLI, and all project dependencies pre-installed .
573
+ Spin up a fully-loaded dev environment ( Python 3.11, Docker/Podman CLI, all project dependencies) in just two clicks .
574
574
575
- ### Prerequisites
575
+ ---
576
+
577
+ <details>
578
+ <summary><strong>📋 Prerequisites</strong></summary>
579
+
580
+ * **VS Code** with the [Dev Containers extension](https://code.visualstudio.com/docs/devcontainers/containers)
581
+ * **Docker** or **Podman** installed and running locally
582
+
583
+ </details>
584
+
585
+ <details>
586
+ <summary><strong>🧰 Setup Instructions</strong></summary>
587
+
588
+ ### 1 · Clone & Open
589
+
590
+ ```bash
591
+ git clone https://github.com/ibm/mcp-context-forge.git
592
+ cd mcp-context-forge
593
+ code .
594
+ ```
595
+
596
+ VS Code will detect the `.devcontainer` and prompt:
597
+ **"Reopen in Container"**
598
+ *or* manually run: <kbd>Ctrl/Cmd ⇧ P</kbd> → **Dev Containers: Reopen in Container**
599
+
600
+ ---
601
+
602
+ ### 2 · First-Time Build (Automatic)
603
+
604
+ The container build will:
605
+
606
+ * Install system packages & Python 3.11
607
+ * Run `make install-dev` to pull all dependencies
608
+ * Execute tests to verify the toolchain
576
609
577
- * **VS Code** with the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
578
- * **Docker** or **Podman** installed and running
579
-
580
- ### Using the Dev Container
581
-
582
- 1 . **Clone the repository:**
583
- ```bash
584
- git clone https://github.com/ibm/mcp-context-forge.git
585
- cd mcp-context-forge
586
- ```
587
-
588
- 2 . **Open in VS Code:**
589
- ```bash
590
- code .
591
- ```
592
-
593
- 3 . **Reopen in Container:**
594
- - VS Code will detect the `.devcontainer` configuration
595
- - Click "Reopen in Container" when prompted, or
596
- - Use Command Palette (`Ctrl/Cmd+Shift+P`) → "Dev Containers: Reopen in Container"
597
-
598
- 4 . **Wait for setup:**
599
- - The container will build automatically (first time may take a few minutes)
600
- - Development dependencies will be installed via `make install-dev`
601
- - Tests will run automatically to verify the setup
602
-
603
- 5 . **Start developing:**
604
- ```bash
605
- make dev # Start development server
606
- make test # Run tests
607
- make lint # Run linting
608
- ```
609
-
610
- ### GitHub Codespaces
611
-
612
- You can also use this project with GitHub Codespaces for cloud-based development:
613
-
614
- 1 . Click the "Code" button on the GitHub repository page
615
- 2 . Select "Codespaces" tab
616
- 3 . Click "Create codespace on main"
617
- 4 . Wait for the environment to be ready (same setup as local dev container)
618
-
619
- The devcontainer includes:
620
- - Python 3.11 with all project dependencies
621
- - Docker CLI for container management
622
- - VS Code extensions for Python and Docker development
623
- - Pre-configured environment variables for development mode
624
- - Automatic setup of `.env` file from `.env.example`
610
+ You'll land in `/workspace` ready to develop.
611
+
612
+ </details>
613
+
614
+ <details>
615
+ <summary><strong>🛠️ Daily Developer Workflow</strong></summary>
616
+
617
+ Common tasks inside the container:
618
+
619
+ ```bash
620
+ # Start dev server (hot reload)
621
+ make dev # http://localhost:4444
622
+
623
+ # Run tests & linters
624
+ make test
625
+ make lint
626
+ ```
627
+
628
+ Optional:
629
+
630
+ * `make bash` — drop into an interactive shell
631
+ * `make clean` — clear build artefacts & caches
632
+ * Port forwarding is automatic (customize via `.devcontainer/devcontainer.json`)
633
+
634
+ </details>
635
+
636
+ <details>
637
+ <summary><strong>☁️ GitHub Codespaces: 1-Click Cloud IDE</strong></summary>
638
+
639
+ No local Docker? Use Codespaces:
640
+
641
+ 1 . Go to the repo → **Code ▸ Codespaces ▸ Create codespace on main**
642
+ 2 . Wait for the container image to build in the cloud
643
+ 3 . Develop using the same workflow above
644
+
645
+ </details>
625
646
626
647
---
627
648
0 commit comments