Skip to content

Commit

Permalink
upd readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JiangShuuu committed Nov 17, 2023
1 parent ba2aefb commit 76d0279
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 29 deletions.
83 changes: 60 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,73 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
# PDF-AI-SAAS (NEXT14 & PRISMA & Trpc & GPT3.5 & NEXTAUTH & STRIPE)

## Getting Started
Demo: https://pdfaisaas.jiangshuuu.com/

First, run the development server:
## 瀏覽專案

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
### 產品功能

- 能創建/登入帳戶(含第三方登入)
- 會員能上傳 PDF
- 會員能針對 PDF 內容提問
- 會員能透過 STRIPE 升級方案

### STRIPE 測試信用卡

https://stripe.com/docs/testing
card: 4242 4242 4242 4242
date: 大於現在
CVC: 任何三位數

## 環境

### 框架

- NEXT14 + typeScript + Prisma + MYSQL + Trpc

### 部署

- Oracle + Docker + GithubAction

### 使用套件

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
- tailwind
- prisma
- radix-ui
- next-auth
- trpc
- openai
- react-dropzone
- react-hook-form
- stripe
- zod
- zustand

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
## 如何啟動專案

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
### 1. 本機需安裝 node.js 與 pnpm

## Learn More
### 2. 開啟終端機建立資料夾或到指定存放位置

To learn more about Next.js, take a look at the following resources:
### 3. 在該資料夾位置,將專案 clone 到本地

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
```
git clone https://github.com/JiangShuuu/next-pdf-ai.git
```

### 4. 透過終端機進入資料夾位置後,輸入:

```
- pnpm install
```

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
### 安裝完成後,繼續輸入:

## Deploy on Vercel
```
- pnpm
```

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
### 終端機顯示此行訊息代表成功運行,打開瀏覽器進入網址:

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
```
Listening on http://localhost:3000
```
Binary file modified src/app/favicon.ico
Binary file not shown.
8 changes: 4 additions & 4 deletions src/app/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ export default async function Home() {
<>
<MaxWidthWrapper className="mb-12 mt-28 flex flex-col items-center justify-center text-center sm:mt-40">
<div className="mx-auto mb-4 flex max-w-fit items-center justify-center space-x-2 overflow-hidden rounded-full border border-gray-200 bg-white px-7 py-2 shadow-md backdrop-blur transition-all hover:border-gray-300 hover:bg-white/50">
<p className="text-sm font-semibold text-gray-700">Quill is now public!</p>
<p className="text-sm font-semibold text-gray-700">PDF-Ai is now public!</p>
</div>
<h1 className="max-w-4xl text-5xl font-bold md:text-6xl lg:text-7xl">
Chat with your <span className="text-blue-600">documents</span> in seconds.
</h1>
<p className="mt-5 max-w-prose text-zinc-700 sm:text-lg">
Quill allows you to have conversations with any PDF document. Simply upload your file and
PDF-Ai allows you to have conversations with any PDF document. Simply upload your file and
start asking questions right away.
</p>

Expand Down Expand Up @@ -80,7 +80,7 @@ export default async function Home() {
Start chatting in minutes
</h2>
<p className="mt-4 text-lg text-gray-600">
Chatting to your PDF files has never been easier than with Quill.
Chatting to your PDF files has never been easier than with PDF-Ai.
</p>
</div>
</div>
Expand Down Expand Up @@ -114,7 +114,7 @@ export default async function Home() {
<span className="text-sm font-medium text-blue-600">Step 3</span>
<span className="text-xl font-semibold">Start asking questions</span>
<span className="mt-2 text-zinc-700">
It&apos;s that simple. Try out Quill today - it really takes less than a minute.
It&apos;s that simple. Try out PDF-Ai today - it really takes less than a minute.
</span>
</div>
</li>
Expand Down
2 changes: 1 addition & 1 deletion src/components/Navbar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const Navbar = ({ currentUser }: NavbarProps) => {
<MaxWidthWrapper>
<div className="flex h-14 items-center justify-between border-b border-zinc-200">
<Link href="/" className="z-40 flex font-semibold">
<span>quill.</span>
<span>PDF-Ai Chat</span>
</Link>

<MobileNav isAuth={!!user} />
Expand Down
2 changes: 1 addition & 1 deletion src/lib/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export function cn(...inputs: ClassValue[]) {

export function constructMetadata({
title = 'PDF-Ai - the Ai Chat SaaS ',
description = 'Quill is an open-source software to make chatting to your PDF files easy.',
description = 'PDF-Ai is an open-source software to make chatting to your PDF files easy.',
image = '/thumbnail.png',
icons = '/favicon.ico',
noIndex = false
Expand Down

0 comments on commit 76d0279

Please sign in to comment.