diff --git a/README.md b/README.md new file mode 100644 index 0000000..8378716 --- /dev/null +++ b/README.md @@ -0,0 +1,71 @@ +
+

+ Logo +
+ Web UI of Oxygen Toolbox +

+
+
+ + Build + + + Release + + + LICENSE + +
+ +# 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 + + RewriteEngine On + RewriteBase / + RewriteRule ^index\.html$ - [L] + RewriteCond %{REQUEST_FILENAME} !-f + RewriteCond %{REQUEST_FILENAME} !-d + RewriteRule . /index.html [L] + +``` diff --git a/README_zh.md b/README_zh.md new file mode 100644 index 0000000..352cae2 --- /dev/null +++ b/README_zh.md @@ -0,0 +1,71 @@ +
+

+ Logo +
+ Web UI of Oxygen Toolbox +

+
+
+ + Build + + + Release + + + LICENSE + +
+ +# 概述 (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 + + RewriteEngine On + RewriteBase / + RewriteRule ^index\.html$ - [L] + RewriteCond %{REQUEST_FILENAME} !-f + RewriteCond %{REQUEST_FILENAME} !-d + RewriteRule . /index.html [L] + +``` diff --git a/doc/logo.svg b/doc/logo.svg new file mode 100644 index 0000000..6b67342 --- /dev/null +++ b/doc/logo.svg @@ -0,0 +1 @@ +