SENODROOM commited on
Commit
80b02e0
·
1 Parent(s): 1ca4563

submodule

Browse files
Files changed (4) hide show
  1. .gitignore +5 -0
  2. .gitmodules +3 -0
  3. README.md +25 -0
  4. website +1 -0
.gitignore CHANGED
@@ -10,6 +10,11 @@ dist/
10
  build/
11
  .eggs/
12
 
 
 
 
 
 
13
  # Data & Models (too large for git)
14
  data/raw/
15
  data/processed/
 
10
  build/
11
  .eggs/
12
 
13
+ # Node / React docs site
14
+ node_modules/
15
+ dist/
16
+ npm-debug.log*
17
+
18
  # Data & Models (too large for git)
19
  data/raw/
20
  data/processed/
.gitmodules ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ [submodule "website"]
2
+ path = website
3
+ url =https://github.com/QUantumLogicsLabs/Github-Profile-AI-Reviewer-Website.git
README.md CHANGED
@@ -20,6 +20,7 @@ app/
20
  backend/ Legacy LangGraph prototype pipeline
21
  experiments/ Standalone prototype files
22
  scripts/ Developer utilities and CLI helpers
 
23
  ```
24
 
25
  ## Token Behavior
@@ -50,6 +51,21 @@ Keep `SCORING_BACKEND=heuristic` unless you have trained model weights. The neur
50
 
51
  ## Run Locally
52
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
53
  On Windows PowerShell, use a project virtual environment:
54
 
55
  ```powershell
@@ -111,6 +127,15 @@ docker compose down
111
 
112
  For a cloud VM, install Docker, clone the repo, create `.env`, then run the same `docker compose up --build -d` command. If you deploy behind a domain or reverse proxy, forward public traffic to container port `8000`.
113
 
 
 
 
 
 
 
 
 
 
114
  ## Use The API In `index.html`
115
 
116
  The frontend at `app/static/index.html` calls the API with `fetch`:
 
20
  backend/ Legacy LangGraph prototype pipeline
21
  experiments/ Standalone prototype files
22
  scripts/ Developer utilities and CLI helpers
23
+ src/ React documentation website
24
  ```
25
 
26
  ## Token Behavior
 
51
 
52
  ## Run Locally
53
 
54
+ Run the React documentation website from the repository root:
55
+
56
+ ```powershell
57
+ npm install
58
+ npm run dev
59
+ ```
60
+
61
+ Open:
62
+
63
+ ```text
64
+ http://localhost:5173/
65
+ ```
66
+
67
+ Run the FastAPI backend separately:
68
+
69
  On Windows PowerShell, use a project virtual environment:
70
 
71
  ```powershell
 
127
 
128
  For a cloud VM, install Docker, clone the repo, create `.env`, then run the same `docker compose up --build -d` command. If you deploy behind a domain or reverse proxy, forward public traffic to container port `8000`.
129
 
130
+ Build the React documentation site:
131
+
132
+ ```bash
133
+ npm install
134
+ npm run build
135
+ ```
136
+
137
+ The static output is generated in `dist/`. You can deploy `dist/` to Netlify, Vercel, GitHub Pages, Nginx, or any static hosting provider.
138
+
139
  ## Use The API In `index.html`
140
 
141
  The frontend at `app/static/index.html` calls the API with `fetch`:
website ADDED
@@ -0,0 +1 @@
 
 
1
+ Subproject commit e63728f239db14bf060809da2b44af073ea3cc6c