docs: readme image license
This commit is contained in:
Liuweiqing
parent
6382683f91
commit
53e42f8613
21
LICENSE
Normal file
21
LICENSE
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2024 liuweiqing
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
103
README.md
103
README.md
|
|
@ -1,93 +1,64 @@
|
||||||
<a href="https://demo-nextjs-with-supabase.vercel.app/">
|
<a href="https://paperai.life>
|
||||||
<img alt="Next.js and Supabase Starter Kit - the fastest way to build apps with Next.js and Supabase" src="https://demo-nextjs-with-supabase.vercel.app/opengraph-image.png">
|
<img alt="Next.js and Supabase Starter Kit - the fastest way to build apps with Next.js and Supabase" src="https://paperai.life/opengraph-image.png">
|
||||||
<h1 align="center">Next.js and Supabase Starter Kit</h1>
|
<h1 align="center">paper-ai</h1>
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
The fastest way to build apps with Next.js and Supabase
|
The fastest way to write a paper with true references
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="#features"><strong>Features</strong></a> ·
|
<a href="#功能"><strong>功能</strong></a> ·
|
||||||
<a href="#demo"><strong>Demo</strong></a> ·
|
<a href="#演示"><strong>演示</strong></a> ·
|
||||||
<a href="#deploy-to-vercel"><strong>Deploy to Vercel</strong></a> ·
|
<a href="#部署到 Vercel"><strong>部署到 Vercel</strong></a> ·
|
||||||
<a href="#clone-and-run-locally"><strong>Clone and run locally</strong></a> ·
|
<a href="#克隆并在本地运行"><strong>克隆并在本地运行y</strong></a> ·
|
||||||
<a href="#feedback-and-issues"><strong>Feedback and issues</strong></a>
|
<!-- <a href="#feedback-and-issues"><strong>Feedback and issues</strong></a>
|
||||||
<a href="#more-supabase-examples"><strong>More Examples</strong></a>
|
<a href="#more-supabase-examples"><strong>More Examples</strong></a> -->
|
||||||
</p>
|
</p>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
## Features
|
- [English Documentation](./README_en.md)
|
||||||
|
|
||||||
- Works across the entire [Next.js](https://nextjs.org) stack
|
## 功能
|
||||||
- App Router
|
|
||||||
- Pages Router
|
|
||||||
- Middleware
|
|
||||||
- Client
|
|
||||||
- Server
|
|
||||||
- It just works!
|
|
||||||
- supabase-ssr. A package to configure Supabase Auth to use cookies
|
|
||||||
- Styling with [Tailwind CSS](https://tailwindcss.com)
|
|
||||||
- Optional deployment with [Supabase Vercel Integration and Vercel deploy](#deploy-your-own)
|
|
||||||
- Environment variables automatically assigned to Vercel project
|
|
||||||
|
|
||||||
## Demo
|
### 利用人工智能撰写论文
|
||||||
|
|
||||||
You can view a fully working demo at [demo-nextjs-with-supabase.vercel.app](https://demo-nextjs-with-supabase.vercel.app/).
|
- **人工智能书写功能**： 点击 "AI 写作 "进行正常对话互动。人工智能将根据您的输入提供写作建议或回答问题。
|
||||||
|
- **Paper2AI功能**： 点击 "Paper2AI"，根据输入的关键词在Semantic Scholar或arxiv中搜索论文。系统将把信息整合到您的论文中。
|
||||||
|
|
||||||
## Deploy to Vercel
|
### 编辑和修改
|
||||||
|
|
||||||
Vercel deployment will guide you through creating a Supabase account and project.
|
- 在编辑器中直接编辑和修改人工智能生成的内容。
|
||||||
|
- 使用提供的工具调整文本样式和布局。
|
||||||
|
|
||||||
After installation of the Supabase integration, all relevant environment variables will be assigned to the project so the deployment is fully functioning.
|
## 演示
|
||||||
|
|
||||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&project-name=nextjs-with-supabase&repository-name=nextjs-with-supabase&demo-title=nextjs-with-supabase&demo-description=This%20starter%20configures%20Supabase%20Auth%20to%20use%20cookies%2C%20making%20the%20user's%20session%20available%20throughout%20the%20entire%20Next.js%20app%20-%20Client%20Components%2C%20Server%20Components%2C%20Route%20Handlers%2C%20Server%20Actions%20and%20Middleware.&demo-url=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2F&external-id=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&demo-image=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2Fopengraph-image.png&integration-ids=oac_VqOgBHqhEoFTPzGkPd7L0iH6)
|
您可以在 [paperai.life](https://paperai.life) 查看完整的工作演示。
|
||||||
|
|
||||||
The above will also clone the Starter kit to your GitHub, you can clone that locally and develop locally.
|
## 部署到 Vercel
|
||||||
|
|
||||||
If you wish to just develop locally and not deploy to Vercel, [follow the steps below](#clone-and-run-locally).
|
[](https://vercel.com/new/clone?repository-url=https://github.com/14790897/paper-ai&project-name=paper-ai&repository-name=paper-ai&demo-title=paper-ai&demo-description=This%20starter%20configures%20Supabase%20Auth%20to%20use%20cookies%2C%20making%20the%20user's%20session%20available%20through%20the%20entire%20Next. js%20app%20-%20Client%20Components%2C%20Server%20Components%2C%20Route%20Handlers%2C%20Server%20Actions%20and%20Middleware.&demo-url=https%3A%2F%2Fdemo-nextjs-with-supabase. vercel.app%2F&external-id=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&demo-image=https%3A%2F%2Fpaperai.life%2Fopengraph-image.png)
|
||||||
|
|
||||||
## Clone and run locally
|
上述操作还会将 repo 克隆到 GitHub。
|
||||||
|
|
||||||
1. You'll first need a Supabase project which can be made [via the Supabase dashboard](https://database.new)
|
如果只想在本地开发，而不想部署到 Vercel，[请按以下步骤操作](#clone-and-run-locally)。
|
||||||
|
|
||||||
2. Create a Next.js app using the Supabase Starter template npx command
|
## 克隆并在本地运行
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx create-next-app -e with-supabase
|
# 克隆版本库
|
||||||
```
|
git clone https://github.com/14790897/paper-ai.git
|
||||||
|
|
||||||
3. Use `cd` to change into the app's directory
|
# 进入项目目录
|
||||||
|
cd paper-ai
|
||||||
|
|
||||||
```bash
|
# 安装依赖项
|
||||||
cd name-of-new-app
|
npm install
|
||||||
```
|
|
||||||
|
|
||||||
4. Rename `.env.local.example` to `.env.local` and update the following:
|
# 运行项目
|
||||||
|
npm run dev
|
||||||
|
|
||||||
```
|
```
|
||||||
NEXT_PUBLIC_SUPABASE_URL=[INSERT SUPABASE PROJECT URL]
|
|
||||||
NEXT_PUBLIC_SUPABASE_ANON_KEY=[INSERT SUPABASE PROJECT API ANON KEY]
|
|
||||||
```
|
|
||||||
|
|
||||||
Both `NEXT_PUBLIC_SUPABASE_URL` and `NEXT_PUBLIC_SUPABASE_ANON_KEY` can be found in [your Supabase project's API settings](https://app.supabase.com/project/_/settings/api)
|
## 许可证
|
||||||
|
MIT
|
||||||
5. You can now run the Next.js local development server:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run dev
|
|
||||||
```
|
|
||||||
|
|
||||||
The starter kit should now be running on [localhost:3000](http://localhost:3000/).
|
|
||||||
|
|
||||||
> Check out [the docs for Local Development](https://supabase.com/docs/guides/getting-started/local-development) to also run Supabase locally.
|
|
||||||
|
|
||||||
## Feedback and issues
|
|
||||||
|
|
||||||
Please file feedback and issues over on the [Supabase GitHub org](https://github.com/supabase/supabase/issues/new/choose).
|
|
||||||
|
|
||||||
## More Supabase examples
|
|
||||||
|
|
||||||
- [Next.js Subscription Payments Starter](https://github.com/vercel/nextjs-subscription-payments)
|
|
||||||
- [Cookie-based Auth and the Next.js 13 App Router (free course)](https://youtube.com/playlist?list=PL5S4mPUpp4OtMhpnp93EFSo42iQ40XjbF)
|
|
||||||
- [Supabase Auth and the Next.js App Router](https://github.com/supabase/supabase/tree/master/examples/auth/nextjs)
|
|
||||||
61
README_en.md
Normal file
61
README_en.md
Normal file
|
|
@ -0,0 +1,61 @@
|
||||||
|
<a href="https://paperai.life>
|
||||||
|
<img alt="Next.js and Supabase Starter Kit - the fastest way to build apps with Next.js and Supabase" src="https://paperai.life/opengraph-image.png">
|
||||||
|
<h1 align="center">paper-ai</h1>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
The fastest way to write a paper with true references
|
||||||
|
</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="#feedback-and-issues"><strong>Feedback and issues</strong></a>
|
||||||
|
<a href="#more-supabase-examples"><strong>More Examples</strong></a> -->
|
||||||
|
</p>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
## Features
|
||||||
|
### Using AI for Paper Writing
|
||||||
|
|
||||||
|
- **AI Write Feature**: Click "AI Write" for a normal dialogue interaction. AI will provide writing suggestions or answer questions based on your input.
|
||||||
|
- **Paper2AI Feature**: Click "Paper2AI" to search for papers in Semantic Scholar or arxiv based on entered keywords. The system will integrate the information into your paper.
|
||||||
|
|
||||||
|
### Editing and Modifying
|
||||||
|
|
||||||
|
- Directly edit and modify the AI-generated content in the editor.
|
||||||
|
- Use the provided tools to adjust text style and layout.
|
||||||
|
|
||||||
|
## Demo
|
||||||
|
|
||||||
|
You can view a fully working demo at [paperai.life](https://paperai.life).
|
||||||
|
|
||||||
|
## Deploy to Vercel
|
||||||
|
|
||||||
|
[](https://vercel.com/new/clone?repository-url=https://github.com/14790897/paper-ai&project-name=paper-ai&repository-name=paper-ai&demo-title=paper-ai&demo-description=This%20starter%20configures%20Supabase%20Auth%20to%20use%20cookies%2C%20making%20the%20user's%20session%20available%20throughout%20the%20entire%20Next.js%20app%20-%20Client%20Components%2C%20Server%20Components%2C%20Route%20Handlers%2C%20Server%20Actions%20and%20Middleware.&demo-url=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2F&external-id=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&demo-image=https%3A%2F%2Fpaperai.life%2Fopengraph-image.png)
|
||||||
|
|
||||||
|
The above will also clone the repo to your GitHub, you can clone that locally and develop locally.
|
||||||
|
|
||||||
|
If you wish to just develop locally and not deploy to Vercel, [follow the steps below](#clone-and-run-locally).
|
||||||
|
|
||||||
|
## Clone and run locally
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Clone the repository
|
||||||
|
git clone https://github.com/14790897/paper-ai.git
|
||||||
|
|
||||||
|
# Enter the project directory
|
||||||
|
cd paper-ai
|
||||||
|
|
||||||
|
# Install dependencies
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# Run the project
|
||||||
|
npm run dev
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## LICENSE
|
||||||
|
MIT
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 283 KiB After Width: | Height: | Size: 278 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 283 KiB After Width: | Height: | Size: 278 KiB |
|
|
@ -2,7 +2,7 @@ export default function DeployButton() {
|
||||||
return (
|
return (
|
||||||
<a
|
<a
|
||||||
className="py-2 px-3 flex rounded-md no-underline hover:bg-btn-background-hover border"
|
className="py-2 px-3 flex rounded-md no-underline hover:bg-btn-background-hover border"
|
||||||
href="https://vercel.com/new/clone?repository-url=https://github.com/14790897/paper-ai&project-name=paper-ai&repository-name=paper-ai&demo-title=paper-ai&demo-description=This%20starter%20configures%20Supabase%20Auth%20to%20use%20cookies%2C%20making%20the%20user's%20session%20available%20throughout%20the%20entire%20Next.js%20app%20-%20Client%20Components%2C%20Server%20Components%2C%20Route%20Handlers%2C%20Server%20Actions%20and%20Middleware.&demo-url=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2F&external-id=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&demo-image=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2Fopengraph-image.png"
|
href="https://vercel.com/new/clone?repository-url=https://github.com/14790897/paper-ai&project-name=paper-ai&repository-name=paper-ai&demo-title=paper-ai&demo-description=This%20starter%20configures%20Supabase%20Auth%20to%20use%20cookies%2C%20making%20the%20user's%20session%20available%20throughout%20the%20entire%20Next.js%20app%20-%20Client%20Components%2C%20Server%20Components%2C%20Route%20Handlers%2C%20Server%20Actions%20and%20Middleware.&demo-url=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2F&external-id=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&demo-image=https%3A%2F%2Fpaperai.life%2Fopengraph-image.png"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
rel="noreferrer"
|
rel="noreferrer"
|
||||||
>
|
>
|
||||||
|
|
@ -22,5 +22,4 @@ export default function DeployButton() {
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// "https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&project-name=nextjs-with-supabase&repository-name=nextjs-with-supabase&demo-title=nextjs-with-supabase&demo-description=This%20starter%20configures%20Supabase%20Auth%20to%20use%20cookies%2C%20making%20the%20user's%20session%20available%20throughout%20the%20entire%20Next.js%20app%20-%20Client%20Components%2C%20Server%20Components%2C%20Route%20Handlers%2C%20Server%20Actions%20and%20Middleware.&demo-url=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2F&external-id=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&demo-image=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2Fopengraph-image.png&integration-ids=oac_VqOgBHqhEoFTPzGkPd7L0iH6";
|
||||||
// "https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&project-name=nextjs-with-supabase&repository-name=nextjs-with-supabase&demo-title=nextjs-with-supabase&demo-description=This%20starter%20configures%20Supabase%20Auth%20to%20use%20cookies%2C%20making%20the%20user's%20session%20available%20throughout%20the%20entire%20Next.js%20app%20-%20Client%20Components%2C%20Server%20Components%2C%20Route%20Handlers%2C%20Server%20Actions%20and%20Middleware.&demo-url=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2F&external-id=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&demo-image=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2Fopengraph-image.png&integration-ids=oac_VqOgBHqhEoFTPzGkPd7L0iH6";
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user