# QuickResearch

**Repository Path**: mawenke/quick-research

## Basic Information

- **Project Name**: QuickResearch
- **Description**: quick-research
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-05-24
- **Last Updated**: 2024-11-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# QuickResearch 后台管理系统

## 介绍

QuickResearch 后台管理系统是一个基于 Flask 的简单 Web 应用程序，用于管理子系统和 Docker 镜像。通过该系统，用户可以轻松地配置服务器信息、管理允许的镜像列表，以及创建和删除子系统。

## 特性

- **配置管理**：设置服务器 IP、子系统用户名和密码。
- **镜像管理**：定义允许的 Docker 镜像列表。
- **子系统管理**：创建和删除子系统，配置端口并生成访问链接。

## 文件说明

- `quick-research-web.py`：主应用代码，定义了系统的各个路由及其对应的操作。
- `data.json`：存储用户、子系统、配置信息及允许的镜像列表。

## 先决条件

- Python 3.5+
- Flask

## 安装和运行

```bash
cd
git clone https://gitee.com/mawenke/quick-research.git
cd quick-research
sudo bash ./quick-research_install.sh -a
pip3 install Flask
cd app
bash start_quick-research-web.sh
```

应用会在运行在后台，通过浏览器访问 `http://本机ip:9003`  地址来使用应用。

## 使用说明

### 访问主页面

启动应用后，通过浏览器访问 `http://<your-server-ip>:9003` 进入 QuickResearch 后台管理系统主页。

### 配置管理

1. **设置服务器 IP、子系统用户名和密码**：
    - 填写相关信息后，点击“保存配置”按钮。
    - 配置信息将存储在 `data.json` 文件中的 `config` 字段中。

2. **设置允许的镜像列表**：
    - 在允许的镜像列表区域，输入每行一个镜像名称。
    - 点击“保存镜像列表”按钮更新允许的镜像列表。

### 子系统管理

1. **创建子系统**：
    - 输入用户名、选择镜像、配置端口1和端口2。
    - 点击“创建子系统”按钮。
    - 子系统创建成功后，将在子系统列表中显示，并生成远程桌面地址和远程IDE地址。

2. **删除子系统**：
    - 在子系统列表中找到需要删除的子系统，点击“删除”按钮。
    - 输入确认删除提示，确认后即删除该子系统。

## JSON 数据结构

`data.json` 文件主要包含以下几部分：

```json
{
    "users": [],
    "subsystems": [],
    "config": {
        "server_ip": "127.0.0.1",
        "subsystem_username": "handsfree",
        "subsystem_password": "handsfree"
    },
    "allowed_images": [
        "mawenke/quick-research:ubuntu-1804",
        "mawenke/quick-research:ubuntu-1804-ros-melodic",
        ...
    ]
}