system-overview.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781
  1. <!DOCTYPE html>
  2. <html lang="zh-CN">
  3. <head>
  4. <meta charset="UTF-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <title>Simple Knowledge Base - System Overview</title>
  7. <style>
  8. :root {
  9. --primary: #6366f1;
  10. --primary-light: #818cf8;
  11. --primary-dark: #4f46e5;
  12. --bg: #0f172a;
  13. --bg-card: #1e293b;
  14. --bg-code: #0d1117;
  15. --text: #e2e8f0;
  16. --text-muted: #94a3b8;
  17. --border: #334155;
  18. --accent-green: #34d399;
  19. --accent-blue: #38bdf8;
  20. --accent-orange: #fb923c;
  21. --accent-pink: #f472b6;
  22. }
  23. * { margin: 0; padding: 0; box-sizing: border-box; }
  24. body {
  25. font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Noto Sans SC', sans-serif;
  26. background: var(--bg);
  27. color: var(--text);
  28. line-height: 1.7;
  29. }
  30. .hero {
  31. background: linear-gradient(135deg, #1e1b4b 0%, #312e81 30%, #0f172a 70%, #0c0a09 100%);
  32. padding: 80px 20px 60px;
  33. text-align: center;
  34. position: relative;
  35. overflow: hidden;
  36. }
  37. .hero::before {
  38. content: '';
  39. position: absolute;
  40. top: -50%;
  41. left: -50%;
  42. width: 200%;
  43. height: 200%;
  44. background: radial-gradient(circle at 30% 50%, rgba(99, 102, 241, 0.15) 0%, transparent 50%),
  45. radial-gradient(circle at 70% 50%, rgba(56, 189, 248, 0.1) 0%, transparent 50%);
  46. animation: pulse 8s ease-in-out infinite;
  47. }
  48. @keyframes pulse {
  49. 0%, 100% { opacity: 0.6; }
  50. 50% { opacity: 1; }
  51. }
  52. .hero h1 {
  53. font-size: 2.8rem;
  54. font-weight: 800;
  55. background: linear-gradient(135deg, #c7d2fe, #818cf8, #38bdf8);
  56. -webkit-background-clip: text;
  57. -webkit-text-fill-color: transparent;
  58. background-clip: text;
  59. position: relative;
  60. margin-bottom: 12px;
  61. }
  62. .hero .subtitle {
  63. font-size: 1.15rem;
  64. color: var(--text-muted);
  65. position: relative;
  66. max-width: 700px;
  67. margin: 0 auto;
  68. }
  69. .badge-row {
  70. display: flex;
  71. gap: 10px;
  72. justify-content: center;
  73. flex-wrap: wrap;
  74. margin-top: 24px;
  75. position: relative;
  76. }
  77. .badge {
  78. display: inline-flex;
  79. align-items: center;
  80. gap: 6px;
  81. padding: 5px 14px;
  82. border-radius: 999px;
  83. font-size: 0.82rem;
  84. font-weight: 600;
  85. border: 1px solid;
  86. }
  87. .badge.react { color: #61dafb; border-color: #61dafb33; background: #61dafb10; }
  88. .badge.nest { color: #e0234e; border-color: #e0234e33; background: #e0234e10; }
  89. .badge.rag { color: var(--accent-green); border-color: #34d39933; background: #34d39910; }
  90. .badge.ts { color: #3178c6; border-color: #3178c633; background: #3178c610; }
  91. .container {
  92. max-width: 1100px;
  93. margin: 0 auto;
  94. padding: 0 20px;
  95. }
  96. .features-grid {
  97. display: grid;
  98. grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
  99. gap: 20px;
  100. margin: -40px auto 60px;
  101. position: relative;
  102. z-index: 1;
  103. }
  104. .feature-card {
  105. background: var(--bg-card);
  106. border: 1px solid var(--border);
  107. border-radius: 16px;
  108. padding: 28px;
  109. transition: transform 0.2s, border-color 0.2s;
  110. }
  111. .feature-card:hover {
  112. transform: translateY(-3px);
  113. border-color: var(--primary);
  114. }
  115. .feature-card .icon {
  116. width: 44px;
  117. height: 44px;
  118. border-radius: 12px;
  119. display: flex;
  120. align-items: center;
  121. justify-content: center;
  122. font-size: 1.3rem;
  123. margin-bottom: 16px;
  124. }
  125. .feature-card h3 {
  126. font-size: 1.05rem;
  127. margin-bottom: 8px;
  128. color: #f1f5f9;
  129. }
  130. .feature-card p {
  131. font-size: 0.9rem;
  132. color: var(--text-muted);
  133. }
  134. .icon-blue { background: #38bdf818; }
  135. .icon-green { background: #34d39918; }
  136. .icon-orange { background: #fb923c18; }
  137. .icon-pink { background: #f472b618; }
  138. .icon-purple { background: #a78bfa18; }
  139. .icon-yellow { background: #fbbf2418; }
  140. section {
  141. margin-bottom: 56px;
  142. }
  143. .section-title {
  144. font-size: 1.5rem;
  145. font-weight: 700;
  146. margin-bottom: 24px;
  147. padding-bottom: 12px;
  148. border-bottom: 2px solid var(--border);
  149. display: flex;
  150. align-items: center;
  151. gap: 10px;
  152. }
  153. .section-title .num {
  154. display: inline-flex;
  155. align-items: center;
  156. justify-content: center;
  157. width: 32px;
  158. height: 32px;
  159. border-radius: 8px;
  160. background: var(--primary);
  161. font-size: 0.85rem;
  162. font-weight: 700;
  163. flex-shrink: 0;
  164. }
  165. /* Architecture Diagram */
  166. .arch-diagram {
  167. background: var(--bg-card);
  168. border: 1px solid var(--border);
  169. border-radius: 16px;
  170. padding: 32px;
  171. overflow-x: auto;
  172. }
  173. .arch-row {
  174. display: flex;
  175. justify-content: center;
  176. gap: 16px;
  177. margin-bottom: 16px;
  178. flex-wrap: wrap;
  179. }
  180. .arch-box {
  181. padding: 14px 22px;
  182. border-radius: 10px;
  183. font-size: 0.85rem;
  184. font-weight: 600;
  185. text-align: center;
  186. min-width: 140px;
  187. border: 1px solid;
  188. }
  189. .arch-box.frontend { background: #61dafb12; border-color: #61dafb33; color: #61dafb; }
  190. .arch-box.backend { background: #e0234e12; border-color: #e0234e33; color: #e0234e; }
  191. .arch-box.infra { background: #34d39912; border-color: #34d39933; color: #34d399; }
  192. .arch-box.ai { background: #a78bfa12; border-color: #a78bfa33; color: #a78bfa; }
  193. .arch-box.data { background: #fb923c12; border-color: #fb923c33; color: #fb923c; }
  194. .arch-arrow {
  195. text-align: center;
  196. color: var(--text-muted);
  197. font-size: 1.2rem;
  198. margin-bottom: 16px;
  199. }
  200. .arch-label {
  201. text-align: center;
  202. font-size: 0.78rem;
  203. color: var(--text-muted);
  204. text-transform: uppercase;
  205. letter-spacing: 1.5px;
  206. margin-bottom: 10px;
  207. }
  208. /* File Tree */
  209. .file-tree {
  210. background: var(--bg-code);
  211. border: 1px solid var(--border);
  212. border-radius: 12px;
  213. padding: 24px 28px;
  214. font-family: 'Cascadia Code', 'Fira Code', monospace;
  215. font-size: 0.85rem;
  216. line-height: 1.9;
  217. overflow-x: auto;
  218. }
  219. .file-tree .dir { color: var(--accent-blue); font-weight: 600; }
  220. .file-tree .comment { color: #64748b; font-style: italic; }
  221. .file-tree .file { color: var(--text); }
  222. /* Pipeline */
  223. .pipeline {
  224. display: flex;
  225. align-items: center;
  226. gap: 0;
  227. flex-wrap: wrap;
  228. justify-content: center;
  229. margin: 20px 0;
  230. }
  231. .pipeline-step {
  232. padding: 12px 20px;
  233. border-radius: 10px;
  234. font-size: 0.85rem;
  235. font-weight: 600;
  236. text-align: center;
  237. border: 1px solid var(--border);
  238. background: var(--bg-card);
  239. }
  240. .pipeline-arrow {
  241. color: var(--text-muted);
  242. font-size: 1.1rem;
  243. padding: 0 6px;
  244. }
  245. .pipeline-step.active {
  246. border-color: var(--primary);
  247. background: #6366f118;
  248. color: var(--primary-light);
  249. }
  250. /* Tables */
  251. .info-table {
  252. width: 100%;
  253. border-collapse: collapse;
  254. margin: 12px 0;
  255. }
  256. .info-table th, .info-table td {
  257. padding: 10px 16px;
  258. text-align: left;
  259. border-bottom: 1px solid var(--border);
  260. font-size: 0.9rem;
  261. }
  262. .info-table th {
  263. color: var(--text-muted);
  264. font-weight: 600;
  265. font-size: 0.82rem;
  266. text-transform: uppercase;
  267. letter-spacing: 0.5px;
  268. }
  269. .info-table .port {
  270. font-family: 'Cascadia Code', monospace;
  271. color: var(--accent-orange);
  272. font-weight: 600;
  273. }
  274. .info-table .env-key {
  275. font-family: 'Cascadia Code', monospace;
  276. color: var(--accent-green);
  277. font-size: 0.83rem;
  278. }
  279. /* Code Block */
  280. .code-block {
  281. background: var(--bg-code);
  282. border: 1px solid var(--border);
  283. border-radius: 10px;
  284. padding: 18px 22px;
  285. font-family: 'Cascadia Code', 'Fira Code', monospace;
  286. font-size: 0.83rem;
  287. line-height: 1.8;
  288. overflow-x: auto;
  289. margin: 12px 0;
  290. }
  291. .code-block .cmd { color: var(--accent-green); }
  292. .code-block .comment { color: #64748b; }
  293. /* Two Column Layout */
  294. .two-col {
  295. display: grid;
  296. grid-template-columns: 1fr 1fr;
  297. gap: 24px;
  298. }
  299. @media (max-width: 768px) {
  300. .two-col { grid-template-columns: 1fr; }
  301. .hero h1 { font-size: 2rem; }
  302. .features-grid { grid-template-columns: 1fr; }
  303. }
  304. .card {
  305. background: var(--bg-card);
  306. border: 1px solid var(--border);
  307. border-radius: 14px;
  308. padding: 24px;
  309. }
  310. .card h4 {
  311. font-size: 1rem;
  312. margin-bottom: 14px;
  313. color: #f1f5f9;
  314. }
  315. .card ul {
  316. list-style: none;
  317. padding: 0;
  318. }
  319. .card ul li {
  320. padding: 6px 0;
  321. font-size: 0.88rem;
  322. color: var(--text-muted);
  323. display: flex;
  324. align-items: flex-start;
  325. gap: 8px;
  326. }
  327. .card ul li::before {
  328. content: '›';
  329. color: var(--primary-light);
  330. font-weight: 700;
  331. flex-shrink: 0;
  332. }
  333. .step-list {
  334. list-style: none;
  335. padding: 0;
  336. counter-reset: step;
  337. }
  338. .step-list li {
  339. counter-increment: step;
  340. padding: 8px 0;
  341. font-size: 0.88rem;
  342. color: var(--text-muted);
  343. display: flex;
  344. align-items: flex-start;
  345. gap: 10px;
  346. }
  347. .step-list li::before {
  348. content: counter(step);
  349. display: inline-flex;
  350. align-items: center;
  351. justify-content: center;
  352. width: 22px;
  353. height: 22px;
  354. border-radius: 6px;
  355. background: var(--primary);
  356. color: white;
  357. font-size: 0.72rem;
  358. font-weight: 700;
  359. flex-shrink: 0;
  360. }
  361. .troubleshoot-item {
  362. background: var(--bg-card);
  363. border: 1px solid var(--border);
  364. border-radius: 10px;
  365. padding: 16px 20px;
  366. margin-bottom: 10px;
  367. }
  368. .troubleshoot-item strong {
  369. color: #f1f5f9;
  370. font-size: 0.92rem;
  371. }
  372. .troubleshoot-item p {
  373. color: var(--text-muted);
  374. font-size: 0.85rem;
  375. margin-top: 4px;
  376. }
  377. footer {
  378. text-align: center;
  379. padding: 40px 20px;
  380. color: var(--text-muted);
  381. font-size: 0.82rem;
  382. border-top: 1px solid var(--border);
  383. }
  384. </style>
  385. </head>
  386. <body>
  387. <!-- Hero -->
  388. <div class="hero">
  389. <h1>Simple Knowledge Base</h1>
  390. <p class="subtitle">Full-stack RAG Q&A System &mdash; Retrieval-Augmented Generation powered by React 19 + NestJS</p>
  391. <div class="badge-row">
  392. <span class="badge react">React 19</span>
  393. <span class="badge nest">NestJS</span>
  394. <span class="badge rag">RAG System</span>
  395. <span class="badge ts">TypeScript</span>
  396. </div>
  397. </div>
  398. <div class="container">
  399. <!-- Key Features -->
  400. <div class="features-grid">
  401. <div class="feature-card">
  402. <div class="icon icon-purple"> </div>
  403. <h3>Multi-Model Support</h3>
  404. <p>OpenAI-compatible APIs (OpenAI, DeepSeek, Claude) + Google Gemini native SDK with configurable LLM, Embedding, and Rerank models.</p>
  405. </div>
  406. <div class="feature-card">
  407. <div class="icon icon-blue">⚡</div>
  408. <h3>Dual Processing Modes</h3>
  409. <p>Fast Mode via Apache Tika for text extraction, and High-Precision Mode via Vision Pipeline for mixed image/text documents.</p>
  410. </div>
  411. <div class="feature-card">
  412. <div class="icon icon-green"> </div>
  413. <h3>Hybrid Search</h3>
  414. <p>Vector + keyword search with Elasticsearch, source citation, similarity scoring, and configurable chunk size &amp; overlap.</p>
  415. </div>
  416. <div class="feature-card">
  417. <div class="icon icon-orange"> </div>
  418. <h3>User Isolation</h3>
  419. <p>JWT authentication with per-user knowledge bases. Each user has isolated data and configurations.</p>
  420. </div>
  421. <div class="feature-card">
  422. <div class="icon icon-pink"> </div>
  423. <h3>Streaming Responses</h3>
  424. <p>Real-time streaming via Server-Sent Events (SSE) for smooth, low-latency chat interactions.</p>
  425. </div>
  426. <div class="feature-card">
  427. <div class="icon icon-yellow"> </div>
  428. <h3>Multi-Language</h3>
  429. <p>Interface supports Japanese, Chinese, and English with full internationalization for error and API response messages.</p>
  430. </div>
  431. </div>
  432. <!-- Architecture -->
  433. <section>
  434. <h2 class="section-title"><span class="num">1</span> Architecture Overview</h2>
  435. <div class="arch-diagram">
  436. <div class="arch-label">Frontend Layer</div>
  437. <div class="arch-row">
  438. <div class="arch-box frontend">React 19 + Vite<br><small style="opacity:0.7">Port 13001 (dev) / 80 (prod)</small></div>
  439. </div>
  440. <div class="arch-arrow">↕</div>
  441. <div class="arch-label">Backend Layer</div>
  442. <div class="arch-row">
  443. <div class="arch-box backend">NestJS API<br><small style="opacity:0.7">Port 3001</small></div>
  444. <div class="arch-box backend">JWT Auth</div>
  445. <div class="arch-box backend">Chat / RAG</div>
  446. <div class="arch-box backend">Vision Pipeline</div>
  447. </div>
  448. <div class="arch-arrow">↕</div>
  449. <div class="arch-label">AI &amp; Data Layer</div>
  450. <div class="arch-row">
  451. <div class="arch-box ai">OpenAI / Gemini<br><small style="opacity:0.7">LLM + Embedding</small></div>
  452. <div class="arch-box infra">Elasticsearch<br><small style="opacity:0.7">Port 9200</small></div>
  453. <div class="arch-box infra">Apache Tika<br><small style="opacity:0.7">Port 9998</small></div>
  454. <div class="arch-box infra">LibreOffice<br><small style="opacity:0.7">Port 8100</small></div>
  455. <div class="arch-box data">SQLite<br><small style="opacity:0.7">Metadata</small></div>
  456. </div>
  457. </div>
  458. <!-- Processing Pipeline -->
  459. <h4 style="margin-top:28px; margin-bottom:14px; color:#f1f5f9;">Dual Processing Pipeline</h4>
  460. <div class="two-col">
  461. <div class="card">
  462. <h4>Fast Mode (Tika)</h4>
  463. <div class="pipeline">
  464. <div class="pipeline-step active">Upload</div>
  465. <span class="pipeline-arrow">→</span>
  466. <div class="pipeline-step active">Tika Extract</div>
  467. <span class="pipeline-arrow">→</span>
  468. <div class="pipeline-step active">Embed</div>
  469. <span class="pipeline-arrow">→</span>
  470. <div class="pipeline-step active">Store</div>
  471. </div>
  472. <p style="font-size:0.85rem; color:var(--text-muted); text-align:center;">Quick text extraction, no API cost</p>
  473. </div>
  474. <div class="card">
  475. <h4>High-Precision Mode (Vision)</h4>
  476. <div class="pipeline">
  477. <div class="pipeline-step active">Upload</div>
  478. <span class="pipeline-arrow">→</span>
  479. <div class="pipeline-step">LibreOffice</div>
  480. <span class="pipeline-arrow">→</span>
  481. <div class="pipeline-step">PDF→Image</div>
  482. <span class="pipeline-arrow">→</span>
  483. <div class="pipeline-step">Vision Model</div>
  484. </div>
  485. <p style="font-size:0.85rem; color:var(--text-muted); text-align:center;">Preserves layout, charts, and images</p>
  486. </div>
  487. </div>
  488. </section>
  489. <!-- Project Structure -->
  490. <section>
  491. <h2 class="section-title"><span class="num">2</span> Project Structure</h2>
  492. <div class="file-tree">
  493. <span class="dir">simple-kb/</span><br>
  494. ├── <span class="dir">web/</span> <span class="comment"># React frontend (Vite)</span><br>
  495. │ ├── <span class="dir">components/</span> <span class="comment"># UI components (ChatInterface, ConfigPanel, etc.)</span><br>
  496. │ ├── <span class="dir">contexts/</span> <span class="comment"># React Context providers</span><br>
  497. │ ├── <span class="dir">services/</span> <span class="comment"># API client services</span><br>
  498. │ └── <span class="dir">utils/</span> <span class="comment"># Utility functions</span><br>
  499. ├── <span class="dir">server/</span> <span class="comment"># NestJS backend</span><br>
  500. │ ├── <span class="dir">src/</span><br>
  501. │ │ ├── <span class="dir">ai/</span> <span class="comment"># AI services (embedding, etc.)</span><br>
  502. │ │ ├── <span class="dir">api/</span> <span class="comment"># API module</span><br>
  503. │ │ ├── <span class="dir">auth/</span> <span class="comment"># JWT authentication</span><br>
  504. │ │ ├── <span class="dir">chat/</span> <span class="comment"># Chat / RAG module</span><br>
  505. │ │ ├── <span class="dir">elasticsearch/</span> <span class="comment"># Elasticsearch integration</span><br>
  506. │ │ ├── <span class="dir">import-task/</span> <span class="comment"># Import task management</span><br>
  507. │ │ ├── <span class="dir">knowledge-base/</span> <span class="comment"># Knowledge base management</span><br>
  508. │ │ ├── <span class="dir">libreoffice/</span> <span class="comment"># LibreOffice integration</span><br>
  509. │ │ ├── <span class="dir">model-config/</span> <span class="comment"># Model configuration management</span><br>
  510. │ │ ├── <span class="dir">vision/</span> <span class="comment"># Vision model integration</span><br>
  511. │ │ └── <span class="dir">vision-pipeline/</span> <span class="comment"># Vision pipeline orchestration</span><br>
  512. │ ├── <span class="dir">data/</span> <span class="comment"># SQLite database storage</span><br>
  513. │ ├── <span class="dir">uploads/</span> <span class="comment"># Uploaded files storage</span><br>
  514. │ └── <span class="dir">temp/</span> <span class="comment"># Temporary files</span><br>
  515. ├── <span class="dir">docs/</span> <span class="comment"># Documentation (Japanese/Chinese)</span><br>
  516. ├── <span class="dir">nginx/</span> <span class="comment"># Nginx configuration</span><br>
  517. ├── <span class="dir">libreoffice-server/</span> <span class="comment"># LibreOffice conversion service (Python/FastAPI)</span><br>
  518. └── <span class="file">docker-compose.yml</span> <span class="comment"># Docker orchestration</span>
  519. </div>
  520. </section>
  521. <!-- Development Setup -->
  522. <section>
  523. <h2 class="section-title"><span class="num">3</span> Development Setup</h2>
  524. <h4 style="margin-bottom:10px; color:#f1f5f9;">Prerequisites</h4>
  525. <div class="card" style="margin-bottom:20px;">
  526. <ul>
  527. <li>Node.js 18+</li>
  528. <li>Yarn package manager</li>
  529. <li>Docker &amp; Docker Compose</li>
  530. </ul>
  531. </div>
  532. <h4 style="margin-bottom:10px; color:#f1f5f9;">Quick Start</h4>
  533. <div class="code-block">
  534. <span class="comment"># Install dependencies</span><br>
  535. <span class="cmd">yarn install</span><br><br>
  536. <span class="comment"># Start infrastructure services</span><br>
  537. <span class="cmd">docker-compose up -d elasticsearch tika libreoffice</span><br><br>
  538. <span class="comment"># Configure environment</span><br>
  539. <span class="cmd">cp server/.env.sample server/.env</span><br><br>
  540. <span class="comment"># Start both frontend and backend</span><br>
  541. <span class="cmd">yarn dev</span>
  542. </div>
  543. <h4 style="margin:20px 0 10px; color:#f1f5f9;">Development Commands</h4>
  544. <div class="code-block">
  545. <span class="comment"># Frontend only (port 13001)</span><br>
  546. <span class="cmd">cd web && yarn dev</span><br><br>
  547. <span class="comment"># Backend only (port 3001)</span><br>
  548. <span class="cmd">cd server && yarn start:dev</span><br><br>
  549. <span class="comment"># Run tests</span><br>
  550. <span class="cmd">cd server && yarn test</span><br>
  551. <span class="cmd">cd server && yarn test:e2e</span><br><br>
  552. <span class="comment"># Lint and format</span><br>
  553. <span class="cmd">cd server && yarn lint</span><br>
  554. <span class="cmd">cd server && yarn format</span>
  555. </div>
  556. </section>
  557. <!-- Docker Services -->
  558. <section>
  559. <h2 class="section-title"><span class="num">4</span> Docker Services &amp; Ports</h2>
  560. <div class="card">
  561. <table class="info-table">
  562. <thead>
  563. <tr><th>Service</th><th>Port</th><th>Purpose</th></tr>
  564. </thead>
  565. <tbody>
  566. <tr><td>Elasticsearch</td><td class="port">9200</td><td>Vector storage &amp; hybrid search</td></tr>
  567. <tr><td>Apache Tika</td><td class="port">9998</td><td>Document text extraction</td></tr>
  568. <tr><td>LibreOffice Server</td><td class="port">8100</td><td>Document format conversion</td></tr>
  569. <tr><td>Backend API</td><td class="port">3001</td><td>NestJS REST API</td></tr>
  570. <tr><td>Frontend (dev)</td><td class="port">13001</td><td>Vite dev server</td></tr>
  571. <tr><td>Frontend (prod)</td><td class="port">80 / 443</td><td>Nginx reverse proxy</td></tr>
  572. </tbody>
  573. </table>
  574. </div>
  575. </section>
  576. <!-- Environment Configuration -->
  577. <section>
  578. <h2 class="section-title"><span class="num">5</span> Environment Configuration</h2>
  579. <div class="card">
  580. <p style="font-size:0.88rem; color:var(--text-muted); margin-bottom:14px;">Key environment variables in <code style="color:var(--accent-green); background:#0d1117; padding:2px 8px; border-radius:4px; font-size:0.83rem;">server/.env</code></p>
  581. <table class="info-table">
  582. <thead>
  583. <tr><th>Variable</th><th>Default</th><th>Description</th></tr>
  584. </thead>
  585. <tbody>
  586. <tr><td class="env-key">OPENAI_API_KEY</td><td>&mdash;</td><td>OpenAI-compatible API key</td></tr>
  587. <tr><td class="env-key">GEMINI_API_KEY</td><td>&mdash;</td><td>Google Gemini API key</td></tr>
  588. <tr><td class="env-key">ELASTICSEARCH_HOST</td><td>http://localhost:9200</td><td>Elasticsearch URL</td></tr>
  589. <tr><td class="env-key">TIKA_HOST</td><td>http://localhost:9998</td><td>Apache Tika URL</td></tr>
  590. <tr><td class="env-key">LIBREOFFICE_URL</td><td>http://localhost:8100</td><td>LibreOffice server URL</td></tr>
  591. <tr><td class="env-key">JWT_SECRET</td><td>&mdash;</td><td>JWT signing secret</td></tr>
  592. </tbody>
  593. </table>
  594. </div>
  595. </section>
  596. <!-- Code Standards -->
  597. <section>
  598. <h2 class="section-title"><span class="num">6</span> Code Standards</h2>
  599. <div class="two-col">
  600. <div class="card">
  601. <h4>Language Requirements</h4>
  602. <ul>
  603. <li>Code comments must be in English</li>
  604. <li>Log messages must be in English</li>
  605. <li>Error messages must support internationalization</li>
  606. <li>API response messages must support i18n</li>
  607. <li>Interface supports Japanese, Chinese, and English</li>
  608. </ul>
  609. </div>
  610. <div class="card">
  611. <h4>Code Quality</h4>
  612. <ul>
  613. <li>Backend uses Jest for unit and e2e tests</li>
  614. <li>ESLint and Prettier configured for backend</li>
  615. <li>Format: <code style="color:var(--accent-green);">cd server && yarn format</code></li>
  616. <li>Lint: <code style="color:var(--accent-green);">cd server && yarn lint</code></li>
  617. </ul>
  618. </div>
  619. </div>
  620. </section>
  621. <!-- Common Tasks -->
  622. <section>
  623. <h2 class="section-title"><span class="num">7</span> Common Development Tasks</h2>
  624. <div class="two-col">
  625. <div class="card">
  626. <h4>Adding a New API Endpoint</h4>
  627. <ol class="step-list">
  628. <li>Create controller in appropriate module under <code style="color:var(--accent-blue);">server/src/</code></li>
  629. <li>Add service methods with English comments</li>
  630. <li>Update DTOs and validation</li>
  631. <li>Add tests in <code style="color:var(--accent-blue);">*.spec.ts</code> files</li>
  632. </ol>
  633. </div>
  634. <div class="card">
  635. <h4>Adding a New Frontend Component</h4>
  636. <ol class="step-list">
  637. <li>Create component in <code style="color:var(--accent-blue);">web/components/</code></li>
  638. <li>Add TypeScript interfaces in <code style="color:var(--accent-blue);">web/types.ts</code></li>
  639. <li>Use Tailwind CSS for styling</li>
  640. <li>Connect to backend services in <code style="color:var(--accent-blue);">web/services/</code></li>
  641. </ol>
  642. </div>
  643. </div>
  644. </section>
  645. <!-- Deployment -->
  646. <section>
  647. <h2 class="section-title"><span class="num">8</span> Deployment</h2>
  648. <div class="two-col">
  649. <div class="card">
  650. <h4>Development</h4>
  651. <div class="code-block">
  652. <span class="cmd">docker-compose up -d elasticsearch tika libreoffice</span><br>
  653. <span class="cmd">yarn dev</span>
  654. </div>
  655. </div>
  656. <div class="card">
  657. <h4>Production</h4>
  658. <div class="code-block">
  659. <span class="comment"># Build and start all services</span><br>
  660. <span class="cmd">docker-compose up -d</span>
  661. </div>
  662. </div>
  663. </div>
  664. </section>
  665. <!-- Troubleshooting -->
  666. <section>
  667. <h2 class="section-title"><span class="num">9</span> Troubleshooting</h2>
  668. <div class="troubleshoot-item">
  669. <strong>Elasticsearch not starting</strong>
  670. <p>Check memory limits in docker-compose.yml</p>
  671. </div>
  672. <div class="troubleshoot-item">
  673. <strong>File upload failures</strong>
  674. <p>Ensure <code style="color:var(--accent-green);">uploads/</code> and <code style="color:var(--accent-green);">temp/</code> directories exist with proper permissions</p>
  675. </div>
  676. <div class="troubleshoot-item">
  677. <strong>Vision pipeline errors</strong>
  678. <p>Verify LibreOffice server is running and accessible at port 8100</p>
  679. </div>
  680. <div class="troubleshoot-item">
  681. <strong>API key errors</strong>
  682. <p>Check environment variables in <code style="color:var(--accent-green);">server/.env</code></p>
  683. </div>
  684. <div class="troubleshoot-item">
  685. <strong>Database reset</strong>
  686. <p>Delete <code style="color:var(--accent-green);">server/data/metadata.db</code> and Elasticsearch data volume</p>
  687. </div>
  688. </section>
  689. <!-- Debugging -->
  690. <section>
  691. <h2 class="section-title"><span class="num">10</span> Debugging &amp; Health Checks</h2>
  692. <div class="code-block">
  693. <span class="comment"># Check Elasticsearch</span><br>
  694. <span class="cmd">curl http://localhost:9200/_cat/indices</span><br><br>
  695. <span class="comment"># Check Tika</span><br>
  696. <span class="cmd">curl http://localhost:9998/tika</span><br><br>
  697. <span class="comment"># Check LibreOffice</span><br>
  698. <span class="cmd">curl http://localhost:8100/health</span>
  699. </div>
  700. </section>
  701. </div>
  702. <footer>
  703. Simple Knowledge Base &mdash; Full-stack RAG Q&A System &mdash; React 19 + NestJS + Elasticsearch
  704. </footer>
  705. </body>
  706. </html>