Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/14790897/paper-ai
Browse files Browse the repository at this point in the history
  • Loading branch information
14790897 committed Apr 23, 2024
2 parents cd4181c + 3868ad4 commit 8ad486d
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,15 @@
</p>

<p align="center">
<a href='https://docs.paperai.life/' style='font-size: 20px;'><strong>文档网站(教程比较详细,推荐在这里观看)</strong></a>
<a href='https://docs.paperai.life/' style='font-size: 20px;'><strong>文档网站(教程比较详细,推荐阅读这里)</strong></a> ·
<a href='https://www.bilibili.com/video/BV1Ya4y1k75V'><strong>bilibili视频教程</strong></a>
</p>

<p align="center">
<a href="#功能"><strong>功能</strong></a> ·
<a href="#演示"><strong>演示</strong></a> ·
<a href="#部署到Vercel"><strong>部署到 Vercel</strong></a> ·
<a href="#克隆并在本地运行"><strong>克隆并在本地运行</strong></a> ·
<a href="#克隆并在本地运行"><strong>克隆并在本地运行</strong></a>
</p>
<br/>

Expand Down
19 changes: 16 additions & 3 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@
</p>

<p align="center">
<a href='https://docs.paperai.life/' style='font-size: 20px;'><strong> Website Documentation (detailed tutorials, highly recommended)</strong></a>
<a href='https://docs.paperai.life/' style='font-size: 20px;'><strong> Website Documentation (detailed tutorials, highly recommended)</strong></a> ·
<a href='https://www.bilibili.com/video/BV1Ya4y1k75V'><strong>bilibili Video Tutorial</strong></a>
</p>

<p align="center">
<a href="#features"><strong>Features</strong></a> ·
<a href="#demo"><strong>Demo</strong></a> ·
<a href="#deploy-to-vercel"><strong>Deploy to Vercel</strong></a> ·
<a href="#clone-and-run-locally"><strong>Clone and run locally</strong></a> ·
<a href="#clone-and-run-locally"><strong>Clone and run locally</strong></a>
<!-- <a href="#feedback-and-issues"><strong>Feedback and issues</strong></a>
<a href="#more-supabase-examples"><strong>More Examples</strong></a> -->
</p>
Expand Down Expand Up @@ -63,7 +64,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

Expand All @@ -82,6 +89,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

Expand Down

0 comments on commit 8ad486d

Please sign in to comment.