Skip to content

Commit

Permalink
docs: 新增 部署文档
Browse files Browse the repository at this point in the history
  • Loading branch information
CaoMeiYouRen committed Jun 7, 2024
1 parent 0891338 commit 9912a18
Showing 1 changed file with 74 additions and 8 deletions.
82 changes: 74 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,46 +47,112 @@ https://rss-demo.cmyr.ltd/

- node >=16

## 🚀 安装
## 🚀 部署

### Docker 镜像

支持两种注册表:

- Docker Hub: [`caomeiyouren/rss-impact-server`](https://hub.docker.com/r/caomeiyouren/rss-impact-server)
- GitHub: [`ghcr.io/caomeiyouren/rss-impact-server`](https://github.com/CaoMeiYouRen/rss-impact-server/pkgs/container/rss-impact-server)

支持以下架构:

- `linux/amd64`
- `linux/arm/v7`
- `linux/arm64`

有以下几种 tags:

| Tag | 描述 | 举例 |
| :------------- | :------- | :------------ |
| `latest` | 最新 | `latest` |
| `{YYYY-MM-DD}` | 特定日期 | `2024-06-07` |
| `{sha-hash}` | 特定提交 | `sha-0891338` |
| `{version}` | 特定版本 | `1.2.3` |

### Docker Compose 部署(推荐)

下载 [docker-compose.yml](https://github.com/CaoMeiYouRen/rss-impact-server/blob/master/docker-compose.yml)

```sh
wget https://github.com/CaoMeiYouRen/rss-impact-server/blob/master/docker-compose.yml
```

检查有无需要修改的配置

```sh
vim docker-compose.yml # 也可以是你喜欢的编辑器
```

启动

```sh
docker-compose up -d
```

在浏览器中打开 `http://{Server IP}:3000` 即可查看结果

### 手动部署

部署 `RSS Impact` 最直接的方式,您可以按照以下步骤将 `RSS Impact` 部署在您的电脑、服务器或者其他任何地方

```sh
npm install
# 构建后端部分
git clone https://github.com/CaoMeiYouRen/rss-impact-server.git --depth=1
cd rss-impact-server
pnpm i --frozen-lockfile
pnpm build
# 构建前端部分
cd ../
git clone https://github.com/CaoMeiYouRen/rss-impact-web.git --depth=1
cd rss-impact-web
pnpm i --frozen-lockfile
pnpm build
# 复制前端部分到后端
cd ../
cp -rp "rss-impact-web/dist" "rss-impact-server/public"
# 启动项目
cd rss-impact-server
pnpm start
```

在浏览器中打开 `http://{Server IP}:3000` 即可查看结果

## 👨‍💻 使用

```sh
npm run start
pnpm run start
```

## 🛠️ 开发

```sh
npm run dev
pnpm run dev
```

## 🔧 编译

```sh
npm run build
pnpm run build
```

## 🧪 测试

```sh
npm run test
pnpm run test
```

## 🔍 Lint

```sh
npm run lint
pnpm run lint
```

## 💾 Commit

```sh
npm run commit
pnpm run commit
```


Expand Down

0 comments on commit 9912a18

Please sign in to comment.