From c1ca6c48dc09abe1e3ce322ecd856a8f8c3fa99b Mon Sep 17 00:00:00 2001 From: alexis Date: Tue, 20 Jan 2026 13:57:24 +0800 Subject: [PATCH 1/4] docs: update frontend setup --- docs/setup.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index 48a252b..05a9d21 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,6 +1,6 @@ # Development -Environment: +## Environment - Ubuntu Linux (most modern Linux distros and MacOS are supposedly supported.) @@ -8,7 +8,7 @@ Environment: - python 3.10 to 3.13 ---- +## Backend 1. `git clone git@github.com:TechJI-2023/CourseReview.git` @@ -36,8 +36,6 @@ Environment: OFFERINGS_THRESHOLD_FOR_TERM_UPDATE=100 ``` - Also cp .env.example in frontend/ and rename it .env. - 8. Build static files: `make collect` 9. Configure database @@ -122,4 +120,21 @@ Environment: crawl_and_import_data() ``` -14. Run frontend (dev mode): `make dev-frontend` and visit http://127.0.0.1:5173/ +## Frontend +There are two ways of developing/running frontend codes: + - use git submodule, which registered frontend under the `/frontend` sub directory of `CourseReview` repo: + * `cd CourseReview` and run `git submodule update --init --recursive`. + * Run frontend (dev mode): `cd CourseReview`, run `make dev-frontend` and visit http://127.0.0.1:5173/ + * Develop frontend: `cd CourseReview/frontend` and treat it like a normal git repo. + + - Clone the frontend repo as a seperate repo from `CourseReview`(backend): + * `cd ` and run `git clone git@github.com:Tech-JI/CourseFront.git` + * Run frontend (dev mode): `cd CourseFront`, run `bun run dev` and visit http://127.0.0.1:5173/ + +### Set up +Under frontend(`CourseReview/frontend` or `CourseFront`) directory: +1. `cp .env.example .env` + +2. `bun install` + +3. `bun run prek install` (set up git hooks) From 08df2b5f2f230c326beaaa0dcbfbe8bcb38444b9 Mon Sep 17 00:00:00 2001 From: alexis Date: Tue, 20 Jan 2026 14:29:33 +0800 Subject: [PATCH 2/4] chore: update submodule pointer --- frontend | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frontend b/frontend index 464bd99..c79a5e0 160000 --- a/frontend +++ b/frontend @@ -1 +1 @@ -Subproject commit 464bd99514f4ae80a36107c4efc9663b526cc9bb +Subproject commit c79a5e0ade4c2c9996f5102f8b19bb8537c70c41 From 8f6b2248e865442cdb56a077ce8432b68c4c10ef Mon Sep 17 00:00:00 2001 From: alexis Date: Wed, 21 Jan 2026 15:42:15 +0800 Subject: [PATCH 3/4] docs: setup --- docs/setup.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index 05a9d21..52e63c3 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -121,18 +121,19 @@ ``` ## Frontend -There are two ways of developing/running frontend codes: - - use git submodule, which registered frontend under the `/frontend` sub directory of `CourseReview` repo: - * `cd CourseReview` and run `git submodule update --init --recursive`. - * Run frontend (dev mode): `cd CourseReview`, run `make dev-frontend` and visit http://127.0.0.1:5173/ - * Develop frontend: `cd CourseReview/frontend` and treat it like a normal git repo. +Two ways to run/develop the frontend: - - Clone the frontend repo as a seperate repo from `CourseReview`(backend): - * `cd ` and run `git clone git@github.com:Tech-JI/CourseFront.git` - * Run frontend (dev mode): `cd CourseFront`, run `bun run dev` and visit http://127.0.0.1:5173/ +1. Git submodule (in `CourseReview/frontend`): + - `cd CourseReview` and run `git submodule update --init --recursive` + - Dev server: `make dev-frontend` (visit http://127.0.0.1:5173/) + - Development workflow: `cd CourseReview/frontend` (treat it like a normal repo) + +2. Separate repo (frontend only): + - `cd ` and run `git clone git@github.com:Tech-JI/CourseFront.git` + - Dev server: `cd CourseFront` then `bun run dev` (visit http://127.0.0.1:5173/) ### Set up -Under frontend(`CourseReview/frontend` or `CourseFront`) directory: +From the frontend directory (`CourseReview/frontend` or `CourseFront`): 1. `cp .env.example .env` 2. `bun install` From 546134be7321d35b7958533a5b6a29919ad670fa Mon Sep 17 00:00:00 2001 From: alexis Date: Wed, 21 Jan 2026 15:42:39 +0800 Subject: [PATCH 4/4] chore: update submodule frontend --- frontend | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frontend b/frontend index c79a5e0..4f5081a 160000 --- a/frontend +++ b/frontend @@ -1 +1 @@ -Subproject commit c79a5e0ade4c2c9996f5102f8b19bb8537c70c41 +Subproject commit 4f5081afd82023924911f42b7f0e6b3763a372d9