Skip to content

Commit c9602b0

Browse files
committed
docs: fix numbering, redis to valkey and rm Structure.md
1 parent 69f699b commit c9602b0

2 files changed

Lines changed: 9 additions & 227 deletions

File tree

docs/Setup.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ Environment:
2020

2121
5. `uv run pre-commit install` (for installing git hook in .git)
2222

23-
5. Make directory for builds of static files: `mkdir staticfiles`
23+
6. Make directory for builds of static files: `mkdir staticfiles`
2424

25-
6. Create .env file for storing secrets. The contents should be like:
25+
7. Create .env file for storing secrets. The contents should be like:
2626

2727
```ini
2828
# PostgreSQL
@@ -36,9 +36,9 @@ Environment:
3636
OFFERINGS_THRESHOLD_FOR_TERM_UPDATE=100
3737
```
3838

39-
7. Build static files: `make collect`
39+
8. Build static files: `make collect`
4040

41-
8. Configure database
41+
9. Configure database
4242

4343
1. Install Postgres:
4444

@@ -91,11 +91,11 @@ Environment:
9191

9292
10. Auto setup database connection and static file routes in Django: `make migrate`, `make makemigrations`
9393

94-
9. Install cache database redis: `sudo apt install redis-server`, `sudo systemctl start redis`. Run `sudo systemctl enable redis` to auto-start redis service on start-up.
94+
10. Install cache database valkey: `sudo apt install valkey`, `sudo systemctl start valkey`. Run `sudo systemctl enable valkey` to auto-start valkey service on start-up.
9595

96-
10. `make run` and visit <http://127.0.0.1:8000/>
96+
11. `make run` and visit <http://127.0.0.1:8000/>
9797

98-
11. Add local admin:
98+
12. Add local admin:
9999

100100
1. `make createsuperuser`. The email can be blank. Use a strong password in production.
101101

@@ -112,7 +112,7 @@ Environment:
112112
u.save()
113113
```
114114

115-
12. Crawl data from JI official website:
115+
13. Crawl data from JI official website:
116116

117117
1. Edit `COURSE_DETAIL_URL_PREFIX` in `apps/spider/crawlers/orc.py`: Add a number after url param `id` like this: `...?id=23`, so only course id starting from 23 (e.g. 230-239, 2300) will be crawled, so as to save time during development. Remember not to commit this change.
118118

@@ -125,4 +125,4 @@ Environment:
125125
crawl_and_import_data()
126126
```
127127

128-
13. Run frontend (dev mode): `make dev-frontend` and visit http://127.0.0.1:5173/
128+
14. Run frontend (dev mode): `make dev-frontend` and visit http://127.0.0.1:5173/

docs/Structure.md

Lines changed: 0 additions & 218 deletions
This file was deleted.

0 commit comments

Comments
 (0)