From ef7c85448e6b9152fb2ccd4a3fa4c8890c41d1db Mon Sep 17 00:00:00 2001 From: Shi Sheng Date: Fri, 19 Apr 2024 20:14:28 -0400 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E4=BA=86?= =?UTF-8?q?=E8=8B=B1=E6=96=87=E7=9A=84README=20(#38)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update README_en.md * Update README_en.md * Update README_en.md * Update README_en.md * Update README_en.md --- README_en.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README_en.md b/README_en.md index f09820c..5aba615 100644 --- a/README_en.md +++ b/README_en.md @@ -63,7 +63,13 @@ docker run -d -p 3000:3000 \ 14790897/paperai:latest ``` -Replace `CUSTOM_AI_URL` and `CUSTOM_API_KEY` to your own model path and API key +Replace `CUSTOM_AI_URL` and `CUSTOM_API_KEY` to your own AI URL and API key + +## Environment variable description +1. NEXT_PUBLIC_OPENAI_API_KEY sets the key. Simply leave the corresponding position in the settings interface (the gear in the upper right corner) blank, the predetermined variable will be used. +2. NEXT_PUBLIC_AI_URL sets the upstream url. Simply leave the corresponding position in the settings interface (the gear in the upper right corner) blank, the predetermined variable will be used. +3. NEXT_PUBLIC_SEMANTIC_API_KEY sets the `semantic scholar` key to increase the number of requests +4. NEXT_PUBLIC_PUBMED_API_KEY sets the `pubmed` key to increase the number of requests ## Clone and run locally @@ -82,6 +88,12 @@ npm run dev ``` +## Reference + +1. semantic scholar api: https://api.semanticscholar.org/api-docs/#tag/Paper-Data/operation/get_graph_paper_relevance_search +2. pubmed api: https://www.ncbi.nlm.nih.gov/books/NBK25500/ +3. i18n: https://locize.com/blog/next-app-dir-i18n/ + ## LICENSE This repository is licensed under the MIT License From 3868ad4acf416690db6bd7cd940d1f738860cc8f Mon Sep 17 00:00:00 2001 From: Shi Sheng Date: Fri, 19 Apr 2024 21:33:12 -0400 Subject: [PATCH 2/2] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E4=BA=86?= =?UTF-8?q?=E4=B8=AD=E8=8B=B1=E6=96=87=E7=9A=84README=E6=96=87=E4=BB=B6=20?= =?UTF-8?q?(#39)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update README.md * Update README.md * Update README_en.md * Update README.md * Update README.md * Update README.md * Update README_en.md * Update README.md * Update README_en.md --- README.md | 5 +++-- README_en.md | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d8d5e86..a228d53 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,15 @@

-文档网站(教程比较详细,推荐在这里观看) +文档网站(教程比较详细,推荐阅读这里) · +bilibili视频教程

功能 · 演示 · 部署到 Vercel · - 克隆并在本地运行 · + 克隆并在本地运行


diff --git a/README_en.md b/README_en.md index 5aba615..181aa4e 100644 --- a/README_en.md +++ b/README_en.md @@ -10,14 +10,15 @@

- Website Documentation (detailed tutorials, highly recommended) + Website Documentation (detailed tutorials, highly recommended) · +bilibili Video Tutorial

Features · Demo · Deploy to Vercel · - Clone and run locally · + Clone and run locally