Skip to content

Commit

Permalink
📝 Docs(custom): add instruction for how to install
Browse files Browse the repository at this point in the history
  • Loading branch information
Kuingsmile committed Apr 27, 2023
1 parent 0ec50c1 commit 6d4039a
Show file tree
Hide file tree
Showing 4 changed files with 333 additions and 14 deletions.
48 changes: 42 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,57 @@ Word GPT Plus is a word add-in which integrates the chatGPT model into Microsoft

## Getting Started

At first, clone this repo and install dependencies, the run the project.
There are two ways to install Word GPT Plus: through my free hosting service, or by self-hosting it.

I highly recommend utilizing my hosting service as it is both user-friendly and requires no installation of additional dependencies. Furthermore, you will have access to the most up-to-date version of Word GPT Plus at all times.

Rest assured that your privacy is protected as all data is saved using localStorage.

However, if you desire faster speeds and possess expertise with Node.js, self-hosting is also an option.

### Service hosted by me

1. Download the add-in `manifest.xml` file from [here](https://raw.githubusercontent.com/Kuingsmile/word-GPT-Plus/master/release/manifest.xml) and save it to a directory on your computer, such as `C:\Users\username\Documents\WordGPT`.
2. Follow the [Sideload add-in](#sideload-add-in) instructions below to install the add-in.

### Self-hosted

If you want to host the add-in yourself, you will need to clone this repo and install dependencies, then run the project. Need Node.js 16+.

```bash
git clone https://github.com/Kuingsmile/Word-GPT-Plus.git
yarn
yarn run serve
```

To get started with Word GPT Plus, you will need to sideload the add-in into Microsoft Word. Sideloading allows you to install and test add-ins that are not yet available on the Microsoft Store.
Then, follow the [Sideload add-in](#sideload-add-in) instructions below to install the add-in.

### Sideload add-in

To get started with Word GPT Plus, you will need to sideload the add-in into Microsoft Word.

You can find instructions provided by MicroSoft at the following link: [sideload office add-ins](https://learn.microsoft.com/en-us/office/dev/add-ins/testing/create-a-network-shared-folder-catalog-for-task-pane-and-content-add-ins)

To sideload WordGPT, you will need to follow the instructions provided by Microsoft. You can find these instructions at the following link: [sideload office add-ins](https://learn.microsoft.com/en-us/office/dev/add-ins/testing/create-a-network-shared-folder-catalog-for-task-pane-and-content-add-ins)
1. Go to the folder where you saved the `manifest.xml` file, for example `C:\Users\username\Documents\WordGPT`.
2. Open the context menu for the folder(right-click the folder) and select **Properties**.
3. Within the **Properties** dialog box, select the **Sharing** tab, and then select **Share**.
![image](https://learn.microsoft.com/en-us/office/dev/add-ins/images/sideload-windows-properties-dialog.png)
4. Within the **Network access** dialog box, add yourself and any other users you want to share, choose the **Share** button, When you see confirmation that Your folder is shared, note the **full network path** that's displayed immediately following the folder name.
![image](https://learn.microsoft.com/en-us/office/dev/add-ins/images/sideload-windows-network-access-dialog.png)
5. Open a new document in Word, choose the **File** tab, and then choose **Options**.
6. Choose **Trust Center**, and then choose the **Trust Center Settings** button.
7. Choose **Trusted Add-in Catalogs**.
8. In the **Catalog Url** box, enter the **full network path** and then choose **Add Catalog**.
9. Select the **Show in Menu** check box, and then choose **OK**.
![image](https://learn.microsoft.com/en-us/office/dev/add-ins/images/sideload-windows-trust-center-dialog.png)
10. Close and then restart Word.
11. Click **Insert** > **My Add-ins** > **Shared Folder**, choose **GPT Plus**, and then choose **Add**.
12. Enjoy it!
![image](https://user-images.githubusercontent.com/96409857/234744280-9d9f13cf-536b-4fb5-adfa-cbec262d56a2.png)

### How to get access token
## How to get access token

#### email + password accounts
### email + password accounts

To use ChatGPT web API, you'll need an OpenAI access token from the ChatGPT webapp. To do this, you can use any of the following methods which take an email and password and return an access token:

Expand All @@ -56,7 +92,7 @@ To use ChatGPT web API, you'll need an OpenAI access token from the ChatGPT weba

These libraries work with email + password accounts (e.g., they do not support accounts where you auth via Microsoft / Google).

#### Microsoft / Google accounts
### Microsoft / Google accounts

Alternatively, you can manually get an accessToken by logging in to the ChatGPT webapp and then opening `https://chat.openai.com/api/auth/session`, which will return a JSON object containing your accessToken string.

Expand Down
53 changes: 45 additions & 8 deletions README_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,57 @@ Word GPT Plus 是一个集成了 chatGPT 模型的 Word 插件。它允许你基

## 快速开始

首先,克隆这个仓库并安装依赖,然后运行项目。
有两种方法可以安装 Word GPT Plus:通过我的免费web服务,或者自己搭建服务。

我强烈建议使用我的web服务,因为它安装简单快捷,也不需要安装额外的依赖项。此外,你将随时可以访问到最新版本的 Word GPT Plus。

由于所有数据都是使用localStorage保存的,所以你的隐私是受到保护的。

但是,如果你想要更快的速度,并且具有Node.js的专业知识,自己搭建服务也是一个选择。

### 由我提供的服务

1. 下载 [manifest.xml](https://raw.githubusercontent.com/Kuingsmile/word-GPT-Plus/master/release/manifest.xml) 文件并保存到你的电脑上,例如 `C:\Users\username\Documents\WordGPT`.
2. 按照下面的 [旁加载插件](#旁加载插件) 说明安装插件。

### 自己搭建服务

如果你想要自己搭建服务,你需要克隆这个仓库并安装依赖项,然后运行项目。需要 Node.js 16+。

```bash
git clone https://github.com/Kuingsmile/word-GPT-Plus.git
git clone https://github.com/Kuingsmile/Word-GPT-Plus.git
yarn
yarn run serve
```

为了开始使用 Word GPT Plus,你需要将插件旁加载到 Microsoft Word 中。旁加载允许你安装和测试尚未在 Microsoft Store 中提供的插件。
然后,按照下面的 [旁加载插件](#旁加载插件) 说明安装插件。

### 旁加载插件

为了开始使用 Word GPT Plus,你需要将插件旁加载到 Microsoft Word 中。

为了旁加载 Word GPT Plus,你需要遵循 Microsoft 提供的说明。你可以在以下链接找到这些说明:[旁加载 office 插件](https://learn.microsoft.com/en-us/office/dev/add-ins/testing/create-a-network-shared-folder-catalog-for-task-pane-and-content-add-ins)
你可以在下面的链接中找到微软提供的说明:[sideload office add-ins](https://learn.microsoft.com/en-us/office/dev/add-ins/testing/create-a-network-shared-folder-catalog-for-task-pane-and-content-add-ins)

### 如何获取access token
1. 打开你保存了 `manifest.xml` 文件的文件夹,例如 `C:\Users\username\Documents\WordGPT`.
2. 右键点击文件夹打开菜单,选择 **属性**.
3.**属性** 对话框中,选择 **共享** 选项卡,然后选择 **共享**.
![image](https://learn.microsoft.com/en-us/office/dev/add-ins/images/sideload-windows-properties-dialog.png)
4.**网络访问** 对话框中,添加你自己和任何你想要共享的其他用户,选择 **共享** 按钮,当你看到你的文件夹被共享的确认信息时,注意显示在文件夹名称后面的 **完整网络路径**.
![image](https://learn.microsoft.com/en-us/office/dev/add-ins/images/sideload-windows-network-access-dialog.png)
5. 在 Word 中打开一个新文档,选择 **文件** 选项卡,然后选择 **选项**.
6. 选择 **信任中心**,然后选择 **信任中心设置** 按钮.
7. 选择 **信任的目录**.
8.**目录 URL** 框中,输入 **完整网络路径**,然后选择 **添加目录**.
9. 选择 **在菜单中显示** 复选框,然后选择 **确定**.
![image](https://learn.microsoft.com/en-us/office/dev/add-ins/images/sideload-windows-trust-center-dialog.png)
10. 关闭并重新启动 Word.
11. 点击**插入** -> **获取加载项** -> **共享目录**,选择 **Word GPT**.
12. 享受 Word GPT Plus 的强大功能吧!
![image](https://user-images.githubusercontent.com/96409857/234744280-9d9f13cf-536b-4fb5-adfa-cbec262d56a2.png)

#### email + password 账户
## 如何获取access token

### email + password 账户

为了使用 ChatGPT web API,你需要一个来自 ChatGPT webapp 的 OpenAI access token。你可以使用以下任何方法,这些方法都需要一个 email 和 password 并返回一个 access token:

Expand All @@ -55,7 +91,8 @@ yarn run serve
- [acheong08/OpenAIAuth](https://github.com/acheong08/OpenAIAuth)

这些库适用于 email + password 账户(也就是说,它们不支持通过 Microsoft / Google 进行身份验证的账户)。
#### Microsoft / Google 账户

### Microsoft / Google 账户

如果你使用的是 Microsoft / Google 账户,你可以通过登录 ChatGPT webapp 并打开 `https://chat.openai.com/api/auth/session` 来手动获取 accessToken,这将返回一个包含你的 accessToken 字符串的 JSON 对象。

Expand All @@ -69,6 +106,6 @@ yarn run serve

MIT License

## 请给个 ⭐️ 吧
## 请给个 ⭐️ 吧

如果这个项目帮助到了你,请给个 ⭐️ 吧!
101 changes: 101 additions & 0 deletions public/PrivacyPage.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Privacy Policy</title>
<style>
body {
background-color: #f2f2f2;
font-family: Arial, sans-serif;
font-size: 16px;
line-height: 1.6;
margin: 0;
padding: 0;
}

h1 {
font-size: 2.2rem;
text-align: center;
margin-top: 40px;
margin-bottom: 20px;
}

h2 {
font-size: 1.8rem;
margin-top: 40px;
margin-bottom: 20px;
}

h4 {
font-size: 1.4rem;
margin-top: 30px;
margin-bottom: 10px;
}

p {
margin-top: 0;
margin-bottom: 20px;
}

ul {
margin-top: 0;
margin-bottom: 20px;
}

li {
margin-left: 30px;
}

.container {
max-width: 800px;
margin: auto;
padding: 20px;
background-color: #fff;
box-shadow: 0 0 10px rgba(0, 0, 0, 0.2);
}
</style>
</head>

<body>
<div class="container">
<h1>Privacy Policy</h1>
<p>
This Privacy Policy describes how we collect, use, and disclose information when you use our Word GPT Plus add-in
for Microsoft Word.
</p>
<h2>Information We Collect</h2>
<p>We may collect the following information:</p>
<ul>
<li>Usage Information: We may collect information about how you use Word GPT Plus, including the features you use,
the prompts you generate, and the text you input into the add-in.</li>
</ul>
<h2>Use of Information</h2>
<p>We use the information we collect to provide, maintain, and improve Word GPT Plus, including:</p>
<ul>
<li>To generate text based on the input provided by the user</li>
<li>To customize and personalize the prompts and features available to the user</li>
<li>To analyze and improve the performance and usability of Word GPT Plus</li>
<li>To troubleshoot technical issues and provide customer support</li>
</ul>
<h2>Disclosure of Information</h2>
<p>We may disclose usage information we collect to our service providers who perform services on our behalf, such as
hosting, data analytics, and customer support.</p>
<h2>Security</h2>
<p>We take reasonable measures to protect the security of your personal information, including implementing
appropriate technical and organizational measures to prevent unauthorized access, disclosure, alteration, or
destruction of your personal information.</p>
<h2>Access, Correction, and Deletion of Information</h2>
<p>You may have the right to access, correct, or delete the personal information we hold about you. If you wish to
exercise these rights, please contact us using the contact information provided below.</p>
<h2>Updates to this Privacy Policy</h2>
<p>We may update this Privacy Policy from time to time. If we make material changes to this policy, we will
notify you by email or by posting a notice on our website prior to the effective date of the changes.</p>
<h2>Contact Us</h2>
<p>If you have any questions or concerns about this Privacy Policy or our data practices, please contact us at
<a href="https://github.com/Kuingsmile/word-GPT-Plus" target="_blank"> https://github.com/Kuingsmile/word-GPT-Plus</a>.</p>
</div>
</body>

</html>
Loading

0 comments on commit 6d4039a

Please sign in to comment.