Merge pull request #43 from DataRecce/feature/drc-470-doc-provide-the…

…-document-to-setup-codespace

Feature/drc 470 doc provide the document to setup codespace

docs/docs/recce-cloud/setup-gh-codespaces.md

@@ -4,3 +4,93 @@ template: embed.html
 ---
 
 # Recce Cloud - Setup GitHub Codespaces
+
+## Setup Recce Cloud in GitHub Codespaces
+
+### 1. Add the following file content to your `.devcontainer/devcontainer.json` file:
+
+```json
+{
+    "name": "Recce Cloud",
+    "image": "infuseai/dev-container-base-image:latest",
+    "containerEnv": {
+        "RECCE_CI_WORKFLOW_NAME": ".github/workflows/recce_ci.yml", // Path to the Recce CI workflow file
+        "DEPENDENCIES_FILE": "requirements.txt", // Path to the python dependencies file
+    },
+    "customizations": {
+        "vscode": {
+            "settings": {
+                "terminal.integrated.shell.linux": "/bin/bash"
+            }
+        }
+    },
+    "forwardPorts": [ 8000 ],
+    "portsAttributes": {
+        "8000": {
+            "label": "Recce Server",
+            "onAutoForward": "openBrowser"
+        }
+    },
+    "postStartCommand": "post_start_command"
+  }
+```
+The python package file `requirements.txt` will be processed by default. If your project uses a different method to manage dependencies, you can choose one of the following methods to customize the installation process.
+
+1. Set the `DEPENDENCIES_FILE` environment variable to the path of the python dependencies file.
+
+2. Set the `DEPENDENCIES_SHELL_COMMAND` environment variable to the command to run to install the dependencies.
+
+3. Set the `DEPENDENCIES_SHELL_SCRIPT_PATH` environment variable to the path to the shell script to install the dependencies
+
+<!-- TODO: Prepare the setup of Codespaces Secret for DB credential -->
+<details markdown='1'>
+  <summary>Optional Environment Variables</summary>
+
+  The following environment variables can be set in the `containerEnv` section of the `devcontainer.json` file
+
+  - `DEPENDENCIES_FILE`
+  Path to the python dependencies file (Default: `requirements.txt`)
+
+  - `DEPENDENCIES_SHELL_COMMAND`
+  Command to run to install the dependencies
+
+  - `DEPENDENCIES_SHELL_SCRIPT_PATH`
+  Path to shell script to install the dependencies
+
+  - `PRE_INSTALL_DEPENDENCIES_COMMAND`
+  Command to run before installing dependencies
+
+  - `POST_INSTALL_DEPENDENCIES_COMMAND`
+  Command to run after starting the recce server
+
+  - `PRE_LAUNCH_RECCE_SERVER_COMMAND`
+  Command to run before launching the recce server
+
+  - `POST_LAUNCH_RECCE_SERVER_COMMAND`
+  Command to run after launching the recce server
+
+  - `RECCE_CI_WORKFLOW_NAME`
+  Path or name of the Recce CI workflow file (Default: `.github/workflows/recce_ci.yml`)
+
+</details>
+
+
+### 2. Commit the `.devcontainer` folder to your repository.
+```bash
+git add .devcontainer
+git commit -a -s -m "Add devcontainer configuration"
+```
+
+## Verify the Codespaces setup
+
+### 1. Launch a new Codespace instance manually in your repository
+
+### 2. Once the Codespace is ready, open the terminal and run the following commands to verify the codespaces setup
+```bash
+# Verify the dbt's dependencies
+dbt debug
+
+# Verify the Recce CLI version
+recce version
+```
+Please make sure the commands run without any errors.