From a4ef23d6038d0bcff1db4f8cd8da03d749ff9f4f Mon Sep 17 00:00:00 2001
From: Yige <a@wyr.me>
Date: Thu, 9 Mar 2023 18:41:33 +0800
Subject: [PATCH] chore: rename environment variables files (#395)

* chore: rename environment variables files

* docs: update README.md about .env file
---
 .env => .env.example           | 0
 .gitignore                     | 4 ++++
 README.en.md                   | 4 ++--
 README.md                      | 4 ++--
 service/{.env => .env.example} | 0
 5 files changed, 8 insertions(+), 4 deletions(-)
 rename .env => .env.example (100%)
 rename service/{.env => .env.example} (100%)

diff --git a/.env b/.env.example
similarity index 100%
rename from .env
rename to .env.example
diff --git a/.gitignore b/.gitignore
index 5119246..72f5944 100644
--- a/.gitignore
+++ b/.gitignore
@@ -27,3 +27,7 @@ coverage
 *.njsproj
 *.sln
 *.sw?
+
+# Environment variables files
+/service/.env
+/.env
diff --git a/README.en.md b/README.en.md
index 6fa93e4..233c394 100644
--- a/README.en.md
+++ b/README.en.md
@@ -55,7 +55,7 @@ Comparison:
 [Details](https://github.com/Chanzhaoyu/chatgpt-web/issues/138)
 
 Switching Methods:
-1. Go to the `service/.env` file.
+1. Go to the `service/.env.example` file and copy the contents to the `service/.env` file.
 2. For `OpenAI API Key`, fill in the `OPENAI_API_KEY` field [(Get apiKey)](https://platform.openai.com/overview).
 3. For `Web API`, fill in the `OPENAI_ACCESS_TOKEN` field [(Get accessToken)](https://chat.openai.com/api/auth/session).
 4. When both are present, `OpenAI API Key` takes precedence.
@@ -266,7 +266,7 @@ PS: You can also run `pnpm start` directly on the server without packaging.
 
 #### Frontend webpage
 
-1. Modify `VITE_APP_API_BASE_URL` in `.env` at the root directory to your actual backend interface address.
+1. Refer to the root directory `.env.example` file content to create `.env` file, modify `VITE_APP_API_BASE_URL` in `.env` at the root directory to your actual backend interface address.
 2. Run the following command in the root directory and then copy the files in the `dist` folder to the root directory of your website service.
 
 [Reference information](https://cn.vitejs.dev/guide/static-deploy.html#building-the-app)
diff --git a/README.md b/README.md
index 4f421fb..1adad96 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,7 @@
 [查看详情](https://github.com/Chanzhaoyu/chatgpt-web/issues/138)
 
 切换方式：
-1. 进入 `service/.env` 文件
+1. 进入 `service/.env.example` 文件，复制内容到 `service/.env` 文件
 2. 使用 `OpenAI API Key` 请填写 `OPENAI_API_KEY` 字段 [(获取 apiKey)](https://platform.openai.com/overview)
 3. 使用 `Web API` 请填写 `OPENAI_ACCESS_TOKEN` 字段 [(获取 accessToken)](https://chat.openai.com/api/auth/session)
 4. 同时存在时以 `OpenAI API Key` 优先
@@ -261,7 +261,7 @@ PS: 不进行打包，直接在服务器上运行 `pnpm start` 也可
 
 #### 前端网页
 
-1、修改根目录下 `.env` 内 `VITE_APP_API_BASE_URL` 为你的实际后端接口地址
+1、参考根目录下 `.env.example` 文件内容创建 `.env` 文件，修改 `VITE_APP_API_BASE_URL` 为你的实际后端接口地址
 
 2、根目录下运行以下命令，然后将 `dist` 文件夹内的文件复制到你网站服务的根目录下
 
diff --git a/service/.env b/service/.env.example
similarity index 100%
rename from service/.env
rename to service/.env.example