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: README.md
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,11 +14,14 @@ This repository contains the **SQL-to-ARC Converter**, a core component of the F
14
14
15
15
## 🚀 Getting Started (Development)
16
16
17
-
This project uses [uv](https://github.com/astral-sh/uv)for dependency management and workspace orchestration.
17
+
The preferred method for working with this repository is using the **Dev Container** (VS Code).
18
18
19
-
### 1. Prerequisites
19
+
While it is possible to develop without the Dev Container (see prerequisites below), this approach is not tested and is therefore neither documented nor officially supported.
-**Git LFS** (installed via `./scripts/setup-git-lfs.sh`)
24
27
@@ -32,14 +35,9 @@ uv sync --all-packages
32
35
33
36
### 3. Start Local Development Environment
34
37
35
-
The `dev_environment` folder provides a full stack including a PostgreSQL database pre-filled with edaphobase data:
36
-
37
-
```bash
38
-
cd dev_environment
39
-
./start.sh --build
40
-
```
38
+
The `dev_environment` folder provides a full stack including a PostgreSQL database pre-filled with edaphobase data.
41
39
42
-
This will start the database and run a test iteration of the converter.
40
+
Please refer to the **[Development Environment README](dev_environment/README.md)** for detailed instructions on prerequisites (like secret management and mTLS keys), setup, and usage.
43
41
44
42
## 🔧 Component Documentation
45
43
@@ -62,5 +60,5 @@ uv run pytest middleware/sql_to_arc/tests/
0 commit comments