Skip to content

Commit 9cd8acf

Browse files
Yicong-Huangclaude
andauthored
docs: update outdated environment requirements in dev guide (#6112)
### What changes were proposed in this PR? `guide-for-developers.md` told new developers to install a toolchain the repo no longer builds with. Updated to match the actual requirements: | Before | After | Source of truth | | --- | --- | --- | | Java JDK 11 (incl. `java_home -v 11`) | JDK 17 | `build.sbt`, `.jvmopts` | | node "LTS > 18.x" | Node 24 or newer | `frontend/package.json` `engines` | | `npm install -g @angular/cli@16` | `@angular/cli@21` | `@angular/core` 21.2.x | | create new tables "in MySQL" | PostgreSQL | Texera runs on Postgres | `guide-to-frontend-development.md` no longer introduces the frontend as "angular framework (version 6)". ### Any related issues, documentation, discussions? Closes #6106 ### How was this PR tested? Docs-only change. Each stated version was cross-checked against the repo: `build.sbt` / `.jvmopts` (JDK 17), `frontend/package.json` (`"node": ">=24.0.0"`, Angular 21.2.x), and the Postgres-based setup instructions earlier in the same guide. ### Was this PR authored or co-authored using generative AI tooling? Generated-by: Claude Code (Claude Fable 5) Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent 6829fae commit 9cd8acf

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

docs/contribution-guidelines/guide-for-developers.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ weight: 20
55

66
## 0. Requirements
77

8-
#### **Java 11 JDK**
8+
#### **Java 17 JDK**
99

10-
Install `Java JDK 11 (Java Development Kit)` (recommend: `[adoptopenjdk](https://adoptium.net/installation/)`). To verify the installation, run:
10+
Install `Java JDK 17 (Java Development Kit)` (recommend: `[adoptopenjdk](https://adoptium.net/installation/)`). To verify the installation, run:
1111
```console
1212
java -version
1313
```
1414

1515
Next, set `JAVA_HOME`. On macOS you can run:
1616
```
17-
export JAVA_HOME=$(/usr/libexec/java_home -v 11)
17+
export JAVA_HOME=$(/usr/libexec/java_home -v 17)
1818
```
1919
On Windows, add a system environment variable called `JAVA_HOME` that points to the JDK directory.
2020

@@ -44,9 +44,9 @@ sbt --version
4444

4545
If the above command fails on Windows after installation, it is recommended to restart your computer.
4646

47-
#### **node LTS Version > 18.x**
47+
#### **node LTS Version >= 24**
4848

49-
Install an LTS version (not the latest) of `node`. Currently, we require LTS version > 18.x.
49+
Install an LTS version of `node`. Currently, we require version 24 or newer (see `engines` in `frontend/package.json`).
5050

5151
On Windows, install from [https://nodejs.org/en/](https://nodejs.org/en/).
5252

@@ -57,11 +57,11 @@ Verify the installation by:
5757
node -v
5858
```
5959

60-
#### **Angular 16 Cli**
60+
#### **Angular 21 Cli**
6161

62-
Install the angular 16 cli globally:
62+
Install the angular 21 cli globally:
6363
```console
64-
npm install -g @angular/cli@16
64+
npm install -g @angular/cli@21
6565
```
6666

6767
Verify the installation by:
@@ -280,7 +280,7 @@ This command will optimize the frontend code to make it run faster. This step wi
280280
This part is optional; you only need to do this if you are working on a specific task.
281281

282282
### To create a new database table and write queries using Java through Jooq
283-
1. Create the needed new table in MySQL and update `sql/texera_ddl.sql` to include the new table.
283+
1. Create the needed new table in PostgreSQL and update `sql/texera_ddl.sql` to include the new table.
284284
2. Run `sbt DAO/jooqGenerate` to generate the classes for the new table.
285285

286286
Note: Jooq creates DAO for simple operations if the requested SQL query is complex, then the developer can use the generated Table classes to implement the operation

docs/contribution-guidelines/guide-to-frontend-development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 30
66
**Author: Yinan Zhou**
77

88
# Introduction:
9-
If you are new to Texera frontend development team or have little frontend experience using angular framework (version 6), this read intends to provide you with a simple guide of how to get started.
9+
If you are new to Texera frontend development team or have little frontend experience using the angular framework, this read intends to provide you with a simple guide of how to get started.
1010

1111
# Preparation phase:
1212
In a nutshell, angular provides modularity, scalability, and robustness to traditional frontend code design. It separates a website into different individual components that can each perform a certain level of independent tasks. It then connects different components with services so they can work collaboratively. It also provides unit testing at the component level as well as application level.

0 commit comments

Comments
 (0)