From 5f7f55ae412f235021745d8982cf089c7a1a0bc5 Mon Sep 17 00:00:00 2001 From: star7th Date: Thu, 10 Apr 2025 20:53:19 +0800 Subject: [PATCH] docs --- README.md | 41 +++++++++++++++++++++-------------------- README.zh-CN.md | 41 +++++++++++++++++++++-------------------- 2 files changed, 42 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 5bb30e8..e1d93ea 100644 --- a/README.md +++ b/README.md @@ -43,11 +43,29 @@ JiSuXiang (极速箱) is a high-quality, visually appealing online developer too - [Font Awesome](https://fontawesome.com) - Icon library - [TypeScript](https://www.typescriptlang.org/) - Type-safe JavaScript -## 📦 Installation +## 📦 Installation & Deployment + +### Using Docker (Recommended) + +The easiest way to run JiSuXiang is using our official Docker image from Docker Hub: + +```bash +# For x86/x64 architecture +docker pull star7th/jisuxiang:latest +docker run -d --name jisuxiang --restart always -p 3000:3000 star7th/jisuxiang:latest + +# For ARM architecture (e.g., Raspberry Pi, Apple Silicon) +docker pull star7th/jisuxiang:arm-latest +docker run -d --name jisuxiang --restart always -p 3000:3000 star7th/jisuxiang:arm-latest +``` + +### Using Node.js + +For local development or deployment on a Node.js server: 1. Clone the repository: ```bash -git clone https://github.com/yourusername/jisuxiang.git +git clone https://github.com/star7th/jisuxiang.git cd jisuxiang ``` @@ -71,24 +89,7 @@ pnpm dev 4. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application. -## 🚢 Deployment - -### Using Docker - -A Dockerfile is provided for containerized deployment: - -```bash -# Build the Docker image -docker build -t jisuxiang . - -# Run the container -docker run -p 3000:3000 jisuxiang -``` - -### Using Node.js - -For production deployment on a Node.js server: - +For production deployment: ```bash # Build the application npm run build diff --git a/README.zh-CN.md b/README.zh-CN.md index 775e742..b03c9b7 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -43,11 +43,29 @@ - [Font Awesome](https://fontawesome.com) - 图标库 - [TypeScript](https://www.typescriptlang.org/) - 类型安全的JavaScript -## 📦 安装方法 +## 📦 安装与部署 + +### 使用Docker部署(推荐) + +使用Docker Hub上的官方镜像是运行极速箱最简单的方式: + +```bash +# 适用于x86/x64架构 +docker pull star7th/jisuxiang:latest +docker run -d --name jisuxiang --restart always -p 3000:3000 star7th/jisuxiang:latest + +# 适用于ARM架构(如树莓派、Apple Silicon) +docker pull star7th/jisuxiang:arm-latest +docker run -d --name jisuxiang --restart always -p 3000:3000 star7th/jisuxiang:arm-latest +``` + +### 使用Node.js部署 + +用于本地开发或在Node.js服务器上部署: 1. 克隆仓库: ```bash -git clone https://github.com/yourusername/jisuxiang.git +git clone https://github.com/star7th/jisuxiang.git cd jisuxiang ``` @@ -71,24 +89,7 @@ pnpm dev 4. 在浏览器中打开 [http://localhost:3000](http://localhost:3000) 查看应用。 -## 🚢 部署说明 - -### 使用Docker部署 - -提供了Dockerfile用于容器化部署: - -```bash -# 构建Docker镜像 -docker build -t jisuxiang . - -# 运行容器 -docker run -p 3000:3000 jisuxiang -``` - -### 使用Node.js部署 - -在Node.js服务器上进行生产部署: - +生产环境部署: ```bash # 构建应用 npm run build