Refactor(README): Add README.md and README_zh.md

This commit is contained in:
2024-09-06 15:02:25 +08:00
parent e9818d435f
commit 85f3d38faa
3 changed files with 143 additions and 0 deletions

71
README.md Normal file
View File

@@ -0,0 +1,71 @@
<div align="center">
<h1>
<img alt="Logo" src="doc/logo.svg" width="128">
<br>
<span>Web UI of Oxygen Toolbox</span>
</h1>
</div>
<div align="center">
<a href="https://ci.fatweb.top/job/Oxygen%20Toolbox%20UI/">
<img alt="Build" src="https://ci.fatweb.top/job/Oxygen%20Toolbox%20UI/badge/icon">
</a>
<a href="https://github.com/FatttSnake/oxygen-ui/releases/latest">
<img alt="Release" src="https://img.shields.io/github/v/release/FatttSnake/oxygen-ui">
</a>
<a href="LICENSE">
<img alt="LICENSE" src="https://img.shields.io/github/license/FatttSnake/oxygen-ui">
</a>
</div>
# Overview ([ZH](README_zh.md), EN)
This project is a front-end web UI of Oxygen Toolbox and needs to be used with the back-end API.
# Requires
- Web Server (e.g. Nginx, Apache httpd)
# Related projects
[API of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-api)
[Desktop Client of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-desktop)
[Android Client of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-android)
# Quick Start
**1. Download the latest packaged production version from [Releases](https://github.com/FatttSnake/oxygen-ui/releases/latest) page**
**2. Upload the file `oxygen-ui-*.tar.gz` or `oxygen-ui-*.zip` to the web server and unzip it**
**3. Configure pseudo-static**
Nginx:
```nginx
server {
...
index index.html
location / {
try_files $uri $uri/ /index.html;
}
...
}
```
Apache httpd (.htaccess):
```apache
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /
RewriteRule ^index\.html$ - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . /index.html [L]
</IfModule>
```

71
README_zh.md Normal file
View File

@@ -0,0 +1,71 @@
<div align="center">
<h1>
<img alt="Logo" src="doc/logo.svg" width="128">
<br>
<span>Web UI of Oxygen Toolbox</span>
</h1>
</div>
<div align="center">
<a href="https://ci.fatweb.top/job/Oxygen%20Toolbox%20UI/">
<img alt="Build" src="https://ci.fatweb.top/job/Oxygen%20Toolbox%20UI/badge/icon">
</a>
<a href="https://github.com/FatttSnake/oxygen-ui/releases/latest">
<img alt="Release" src="https://img.shields.io/github/v/release/FatttSnake/oxygen-ui">
</a>
<a href="LICENSE">
<img alt="LICENSE" src="https://img.shields.io/github/license/FatttSnake/oxygen-ui">
</a>
</div>
# 概述 (ZH, [EN](README.md))
本项目为 Oxygen Toolbox 的网页 UI需配合后端 API 使用。
# 环境要求
- Web 服务器(如 Nginx, Apache httpd
# 关联项目
[API of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-api)
[Desktop Client of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-desktop)
[Android Client of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-android)
# 快速开始
**1. 从 [Releases](https://github.com/FatttSnake/oxygen-ui/releases/latest) 页面下载最后打包的生产版本**
**2. 将文件 `oxygen-ui-*.tar.gz` 或 `oxygen-ui-*.zip` 上传到 Web 服务器并解压**
**3. 配置伪静态**
Nginx:
```nginx
server {
...
index index.html
location / {
try_files $uri $uri/ /index.html;
}
...
}
```
Apache httpd (.htaccess):
```apache
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /
RewriteRule ^index\.html$ - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . /index.html [L]
</IfModule>
```

1
doc/logo.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 6.9 KiB