Skip to content

Commit 99442f8

Browse files
committed
Add Chinese README and update English README with repository clone steps
1 parent d56ad81 commit 99442f8

2 files changed

Lines changed: 67 additions & 12 deletions

File tree

README.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,46 @@
1+
[English](README.md) | [中文](README.zh.md)
2+
13
![Group 1](https://github.com/Rabithua/Rote/assets/34543831/a06d5a5b-0580-4138-9282-449a725cd287)
24

35
> A personal note repository that looks different🤔
46
57
- Open API, more than one way to record🤩
68
- Take control of your own data, come and go freely, no data hostage🙅🏻
7-
- Using docker for one-click deployment, data backup and migration are as easy as drinking water👌
9+
- Using Docker for one-click deployment, data backup and migration are as easy as drinking water👌
810

911
## Deploy
1012

11-
### 快速开始
13+
### Quick Start
14+
15+
#### Method 1: Using Docker Hub Image (Recommended)
1216

13-
#### 方式一:使用 Docker Hub 镜像(推荐)
17+
> Copy `docker-compose.yml` to your server with Docker and Docker Compose installed
18+
> Note: If you use a reverse proxy, VITE_API_BASE should be your backend address after the reverse proxy
1419
1520
```bash
16-
# 使用最新版本(默认配置文件)
17-
docker-compose up -d
21+
# Use latest version (default config file)
22+
VITE_API_BASE=http://<your-ip-address>:3000 docker-compose up -d
1823

19-
# 使用特定版本
24+
# Use specific version
2025
IMAGE_TAG=v1.0.0 docker-compose up -d
2126
```
2227

23-
#### 方式二:本地构建
28+
#### Method 2: Local Build
2429

2530
```bash
26-
# 从源码构建并启动
27-
# VITE_API_BASE 在构建时注入到前端代码中(可选,默认 http://localhost:3000)
31+
# Clone the repository
32+
git clone https://github.com/Rabithua/Rote.git
33+
cd Rote
34+
35+
# Build and start from source
36+
# VITE_API_BASE is injected into frontend code at build time (optional, default http://localhost:3000)
2837
VITE_API_BASE=http://localhost:3000 docker-compose -f docker-compose.build.yml up -d --build
2938
```
3039

31-
### 详细说明
40+
### Detailed Instructions
3241

33-
更多部署选项和配置说明,请查看 [Docker Compose 使用指南](doc/userguide/DOCKER-COMPOSE-GUIDE.md)
42+
For more deployment options and configuration instructions, please check the documentation in the `doc/` directory.
3443

35-
## Technology stack
44+
## Technology Stack
3645

3746
![Frame 1](https://github.com/Rabithua/Rote/assets/34543831/fc00f797-82bc-47fe-8c75-36ea0b1f6f76)

README.zh.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
[English](README.md) | [中文](README.zh.md)
2+
3+
![Group 1](https://github.com/Rabithua/Rote/assets/34543831/a06d5a5b-0580-4138-9282-449a725cd287)
4+
5+
> 一个看起来不一样的个人笔记仓库 🤔
6+
7+
- 开放 API,不止一种记录方式 🤩
8+
- 自主掌控数据,来去自由,不做数据绑架 🙅🏻
9+
- 使用 Docker 一键部署,数据备份和迁移如喝水般简单 👌
10+
11+
## 部署
12+
13+
### 快速开始
14+
15+
#### 方式一:使用 Docker Hub 镜像(推荐)
16+
17+
> 复制 `docker-compose.yml` 到你的已经装好 Docker 和 Docker Compose 的服务器
18+
> 注意:如果你使用反向代理的话,VITE_API_BASE 应该是你反向代理后的后端地址
19+
20+
```bash
21+
# 使用最新版本(默认配置文件)
22+
VITE_API_BASE=http://<your-ip-address>:3000 docker-compose up -d
23+
24+
# 使用特定版本
25+
IMAGE_TAG=v1.0.0 docker-compose up -d
26+
```
27+
28+
#### 方式二:本地构建
29+
30+
```bash
31+
# 克隆仓库
32+
git clone https://github.com/Rabithua/Rote.git
33+
cd Rote
34+
35+
# 从源码构建并启动
36+
# VITE_API_BASE 在构建时注入到前端代码中(可选,默认 http://localhost:3000)
37+
VITE_API_BASE=http://localhost:3000 docker-compose -f docker-compose.build.yml up -d --build
38+
```
39+
40+
### 详细说明
41+
42+
更多部署选项和配置说明,请查看 `doc/` 目录下的文档。
43+
44+
## 技术栈
45+
46+
![Frame 1](https://github.com/Rabithua/Rote/assets/34543831/fc00f797-82bc-47fe-8c75-36ea0b1f6f76)

0 commit comments

Comments
 (0)