|
4 | 4 |
|
5 | 5 | ## Steps for setup: |
6 | 6 |
|
7 | | -1. Install [nvm](https://github.com/nvm-sh/nvm) and install Node v22.17.0 LTS using `nvm install v22.17.0`. If you're using a different Node version manager, do the equivalent. |
8 | | -2. Activate Node v22.17.0 using `nvm use v22.17.0`. |
| 7 | +1. Install [nvm](https://github.com/nvm-sh/nvm) and install Node v24.14.0 LTS using `nvm install v24.14.1`. If you're using a different Node version manager, do the equivalent. |
| 8 | +2. Activate Node v24.14.1 using `nvm use v24.14.1`. |
9 | 9 | 3. Install pnpm, using `npm i -g pnpm`. |
10 | 10 | 4. Install the packages in this repo by running `pnpm i -r` in the root of this repository. |
11 | 11 |
|
| 12 | +> [!tip] |
| 13 | +> Typescript 7 is now out, and we find the Typescript 7 dev experience to be quite a bit faster than the default in VSCode. We recommend installing the plugins in `.vscode` and setting them up to enable TS7 support. |
| 14 | +
|
12 | 15 | Check [.env.example](./.env.example) for an example env file. It can be arbitrary, though we recommend using: |
13 | 16 |
|
14 | 17 | ``` |
@@ -36,7 +39,6 @@ CHRONO_SECRET="99fcf0561404319f865d52ec3d3d6239ccc1fbcd5f1f6e5c72cbfd3f5b6feff11 |
36 | 39 | LOG_MODE="development" |
37 | 40 | LOG_LEVEL="info" |
38 | 41 | DB_LONG_RUNNING_QUERY_MS=2000 |
39 | | -SEARCH_SERVICE_URL="http://chrono:4713" |
40 | 42 | ``` |
41 | 43 |
|
42 | 44 | Obviously, we'll use different creds in production. |
@@ -184,11 +186,3 @@ If something goes wrong, and you need to overwrite the course data for a semeste |
184 | 186 | **NOTE:** This same `db` container is used in `dev` and `prod` |
185 | 187 |
|
186 | 188 | **NOTE:** This same `ingestion` container is the container that runs the ingestion script. |
187 | | - |
188 | | -## Search service |
189 | | - |
190 | | -For course & timetable search, we'll be using https://github.com/crux-bphc/search-service/. Both the Docker Compose configurations are set to run on the same network (named `chrono_net`). |
191 | | - |
192 | | -Make sure to set the `CHRONO_PORT` environment variable in the search service to an unused port (such as 4713). Then, set the `SEARCH_SERVICE_URL` environment variable here to `http://chrono:XXXX`, replacing `XXXX` with the previously set port. |
193 | | - |
194 | | -Before adding any timetables to the search service, you'll need to add the relevant courses to the search service indexes. A sample way to do this is using https://github.com/crux-bphc/search-service/blob/master/chrono/utils.py. |
0 commit comments