summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuren Hao <97327730+YurenHao0426@users.noreply.github.com>2025-08-06 02:01:22 -0700
committerGitHub <noreply@github.com>2025-08-06 02:01:22 -0700
commite5cbd188c6fc654e8ababd37922c018bc8527c44 (patch)
treeaa89a6d2998ecfc60254e17fd0d3cdb5449a8248 /README.md
parent79ec5fd1f0188a88f937737185c542e644cf98e4 (diff)
parentcaa18e81e8eb03fb03a82d0d3526994c9ba41ac2 (diff)
Merge pull request #1 from YurenHao0426/codex/test-uiuc-api-cors-response
feat: scaffold prereq graph project
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/README.md b/README.md
index b53373d..22b6bb9 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,23 @@
-# uiuc-course-graph \ No newline at end of file
+# UIUC Course Graph
+
+Static UIUC course prerequisite graph powered by React and Cytoscape.js. Course data is fetched from the UIUC Course Explorer API during build time because the API does not allow cross-origin requests.
+
+## CORS check
+
+```
+$ curl -sD - -o /dev/null https://courses.illinois.edu/cisapp/explorer/schedule/2025/fall.xml
+HTTP/1.1 200 OK
+content-type: application/xml;charset=UTF-8
+server: envoy
+# (no Access-Control-Allow-Origin header)
+```
+
+## Development
+
+```bash
+npm install
+npm run scrape # generate data/catalog_2025_fall.json
+npm run dev # start Vite dev server
+```
+
+The GitHub Actions workflow `update-and-deploy.yml` refreshes the catalog daily and deploys the built site to GitHub Pages.