cyber-orbit/ReportX
GitHub: cyber-orbit/ReportX
ReportX 是一个现代化网络安全报告生成器,解决专业安全评估报告撰写效率低、格式繁琐的问题。
Stars: 0 | Forks: 0
# 🔒 ReportX - 专业网络安全报告生成器
ReportX 是一个现代化、用户友好的 Web 应用程序,旨在简化专业网络安全评估报告的创建过程。使用 React 和 Tailwind CSS 构建,它为安全专业人员提供了一个直观的界面,用于生成多种格式的综合报告。
**灵活的导出格式**
- 纯文本 (.txt)
- Markdown (.md)
- HTML (.html)
- PDF (pdf)
- DOCX (DOCX)
## ✨ 功能特性
- **多种报告类型**
- 渗透测试报告
- 恶意软件检测报告
- 漏洞评估报告
- 安全审计报告
- **专业模板**
- 预格式化的专业布局
- 严重级别指示器
- 全面的报告章节
- **用户友好界面**
- 简洁、现代的深色主题 UI
- 实时预览
- 易用的表单输入
- **导出选项**
- 下载报告
- 复制到剪贴板
- 直接打印
## 🚀 快速开始
### 先决条件
- Node.js (v14 或更高版本)
- npm (随 Node.js 附带)
### 安装
#### 在 Linux/Mac 上:
```
# 使安装脚本可执行
chmod +x install.sh
# 运行安装
./install.sh
```
#### 在 Windows 上:
```
# 双击 install.bat 或在命令提示符下运行
install.bat
```
### 运行应用程序
#### 在 Linux/Mac 上:
```
# 使启动脚本可执行
chmod +x start.sh
# 启动开发服务器
./start.sh
```
#### 在 Windows 上:
```
# 双击 start.bat 或在命令提示符下运行
start.bat
```
应用程序将自动在浏览器中打开,地址为 `http://localhost:3000`
## 📦 生产环境构建
#### 在 Linux/Mac 上:
```
chmod +x build.sh
./build.sh
```
#### 在 Windows 上:
```
build.bat
```
生产构建将创建在 `build` 文件夹中。
## 🧹 清理项目
要删除所有依赖项和构建文件:
#### 在 Linux/Mac 上:
```
chmod +x clean.sh
./clean.sh
```
#### 在 Windows 上:
```
clean.bat
```
## 📁 项目结构
```
reportx/
├── public/
│ └── index.html # HTML template
├── src/
│ ├── components/
│ │ └── ReportX.jsx # Main component
│ ├── App.js # App wrapper
│ ├── index.js # Entry point
│ └── index.css # Global styles
├── install.sh # Linux/Mac installation script
├── install.bat # Windows installation script
├── start.sh # Linux/Mac start script
├── start.bat # Windows start script
├── build.sh # Linux/Mac build script
├── build.bat # Windows build script
├── clean.sh # Linux/Mac clean script
├── clean.bat # Windows clean script
├── .gitignore # Git ignore file
├── package.json # Project dependencies
├── tailwind.config.js # Tailwind configuration
├── postcss.config.js # PostCSS configuration
└── README.md # This file
```
## 🎯 使用指南
1. **选择报告类型**:从渗透测试、恶意软件检测、漏洞评估或安全审计中选择
2. **填写报告详情**:
- 公司名称
- 客户名称
- 目标系统
- 评估日期
- 评估人姓名
- 严重级别
3. **完成报告章节**:
- 执行摘要
- 评估范围
- 发现
- 建议
4. **选择导出格式**:在文本、Markdown 或 HTML 之间选择
5. **预览并导出**:在预览区域查看报告,并使用下载、复制或打印选项导出
## 🛠️ 使用技术
- **React 18** - UI 框架
- **Tailwind CSS** - 样式
- **Lucide React** - 图标
- **Create React App** - 构建工具
## 📝 可用脚本
在项目目录中,您可以运行:
- `npm start` - 以开发模式运行应用程序
- `npm run build` - 构建生产环境应用程序
- `npm test` - 启动测试运行器
- `npm run eject` - 退出 Create React App(单向操作)
## 🎨 自定义设置
您可以通过以下方式自定义应用程序:
- 修改 `src/components/ReportX.jsx` 中的报告模板
- 调整 `tailwind.config.js` 中的样式
- 添加新的报告类型或导出格式
## 📄 许可证
本项目是开源的,采用 MIT 许可证。
## 👥 作者
由 CYBER-ORBIT ❤️ 制作
## 🐛 错误报告
如果您发现错误,请在项目仓库中打开一个 issue。
## 💡 功能请求
如果有新功能的构想?请打开 issue 并告诉我们!
**ReportX v1.0** - 专业网络安全报告生成器
**灵活的导出格式**
- 纯文本 (.txt)
- Markdown (.md)
- HTML (.html)
- PDF (pdf)
- DOCX (DOCX)
## ✨ 功能特性
- **多种报告类型**
- 渗透测试报告
- 恶意软件检测报告
- 漏洞评估报告
- 安全审计报告
- **专业模板**
- 预格式化的专业布局
- 严重级别指示器
- 全面的报告章节
- **用户友好界面**
- 简洁、现代的深色主题 UI
- 实时预览
- 易用的表单输入
- **导出选项**
- 下载报告
- 复制到剪贴板
- 直接打印
## 🚀 快速开始
### 先决条件
- Node.js (v14 或更高版本)
- npm (随 Node.js 附带)
### 安装
#### 在 Linux/Mac 上:
```
# 使安装脚本可执行
chmod +x install.sh
# 运行安装
./install.sh
```
#### 在 Windows 上:
```
# 双击 install.bat 或在命令提示符下运行
install.bat
```
### 运行应用程序
#### 在 Linux/Mac 上:
```
# 使启动脚本可执行
chmod +x start.sh
# 启动开发服务器
./start.sh
```
#### 在 Windows 上:
```
# 双击 start.bat 或在命令提示符下运行
start.bat
```
应用程序将自动在浏览器中打开,地址为 `http://localhost:3000`
## 📦 生产环境构建
#### 在 Linux/Mac 上:
```
chmod +x build.sh
./build.sh
```
#### 在 Windows 上:
```
build.bat
```
生产构建将创建在 `build` 文件夹中。
## 🧹 清理项目
要删除所有依赖项和构建文件:
#### 在 Linux/Mac 上:
```
chmod +x clean.sh
./clean.sh
```
#### 在 Windows 上:
```
clean.bat
```
## 📁 项目结构
```
reportx/
├── public/
│ └── index.html # HTML template
├── src/
│ ├── components/
│ │ └── ReportX.jsx # Main component
│ ├── App.js # App wrapper
│ ├── index.js # Entry point
│ └── index.css # Global styles
├── install.sh # Linux/Mac installation script
├── install.bat # Windows installation script
├── start.sh # Linux/Mac start script
├── start.bat # Windows start script
├── build.sh # Linux/Mac build script
├── build.bat # Windows build script
├── clean.sh # Linux/Mac clean script
├── clean.bat # Windows clean script
├── .gitignore # Git ignore file
├── package.json # Project dependencies
├── tailwind.config.js # Tailwind configuration
├── postcss.config.js # PostCSS configuration
└── README.md # This file
```
## 🎯 使用指南
1. **选择报告类型**:从渗透测试、恶意软件检测、漏洞评估或安全审计中选择
2. **填写报告详情**:
- 公司名称
- 客户名称
- 目标系统
- 评估日期
- 评估人姓名
- 严重级别
3. **完成报告章节**:
- 执行摘要
- 评估范围
- 发现
- 建议
4. **选择导出格式**:在文本、Markdown 或 HTML 之间选择
5. **预览并导出**:在预览区域查看报告,并使用下载、复制或打印选项导出
## 🛠️ 使用技术
- **React 18** - UI 框架
- **Tailwind CSS** - 样式
- **Lucide React** - 图标
- **Create React App** - 构建工具
## 📝 可用脚本
在项目目录中,您可以运行:
- `npm start` - 以开发模式运行应用程序
- `npm run build` - 构建生产环境应用程序
- `npm test` - 启动测试运行器
- `npm run eject` - 退出 Create React App(单向操作)
## 🎨 自定义设置
您可以通过以下方式自定义应用程序:
- 修改 `src/components/ReportX.jsx` 中的报告模板
- 调整 `tailwind.config.js` 中的样式
- 添加新的报告类型或导出格式
## 📄 许可证
本项目是开源的,采用 MIT 许可证。
## 👥 作者
由 CYBER-ORBIT ❤️ 制作
## 🐛 错误报告
如果您发现错误,请在项目仓库中打开一个 issue。
## 💡 功能请求
如果有新功能的构想?请打开 issue 并告诉我们!
**ReportX v1.0** - 专业网络安全报告生成器标签:DNS枚举, React, SEO, Syscalls, Tailwind CSS, 专业模板, 复制到剪贴板, 安全审计报告, 实时预览, 导出DOCX, 导出HTML, 导出Markdown, 导出PDF, 导出TXT, 恶意软件分析报告, 打印报告, 报告工具, 报告生成器, 文档生成, 暗色主题, 渗透测试报告, 漏洞评估报告, 用户界面, 网络安全工具, 网络安全报告, 自定义脚本, 表单输入