mayurk224/beacon
GitHub: mayurk224/beacon
一个全栈事件管理和响应平台,用于跟踪、管理和解决安全及运维事件,提供实时监控、团队协作和自动化剧本功能。
Stars: 0 | Forks: 0
# Beacon - 事件管理平台
Beacon 是一个全面的事件管理和响应平台,旨在帮助组织高效地跟踪、管理和解决事件。它提供实时监控、分析、团队协作和自动化剧本工具。
## 🏗️ 项目架构
该项目采用全栈应用架构,前端和后端分离清晰。
- **[客户端](./client)**: 一个基于 React、Vite 和 Tailwind CSS 构建的现代化响应式 Web 应用。
- **[服务器](./server)**: 一个基于 Node.js、Express 和 MongoDB 构建的健壮 RESTful API。
## 🚀 技术栈
### 前端
- **框架**: React 19 (Vite)
- **样式**: Tailwind CSS 4
- **动画**: GSAP
- **状态管理**: React Context API
- **图表**: Chart.js & react-chartjs-2
- **图标**: Lucide React
- **流程图/图表**: @xyflow/react
### 后端
- **运行时**: Node.js
- **框架**: Express 5
- **数据库**: MongoDB (Mongoose)
- **认证**: JWT, Google OAuth 2.0, Bcrypt
- **安全**: Helmet, Express Rate Limit, CORS
- **文件存储**: ImageKit
- **邮件服务**: Nodemailer
- **日志**: Morgan & Rotating File Stream
- **测试**: Jest, Supertest
## 🛠️ 入门指南
### 前置条件
- Node.js (v18 或更高版本)
- npm 或 yarn
- MongoDB Atlas 账户或本地 MongoDB 实例
- ImageKit 账户(用于文件上传)
- Google Cloud Console 项目(用于 Google OAuth)
### 安装
1. **克隆仓库**:
git clone
cd beacon
2. **设置服务器**:
cd server
npm install
# 根据服务器 README 说明创建 .env 文件
npm run dev
3. **设置客户端**:
cd ../client
npm install
# 根据客户端 README 说明创建 .env 文件
npm run dev
## 📂 项目结构
```
beacon/
├── client/ # Frontend React application
│ ├── src/ # Source code
│ └── public/ # Static assets
├── server/ # Backend Express API
│ ├── src/ # API core logic
│ ├── models/ # Mongoose models
│ ├── routes/ # API routes
│ └── tests/ # Unit and integration tests
└── README.md # Project root documentation
```
## 🤝 贡献
欢迎贡献!请随时提交 Pull Request。
1. Fork 本项目
2. 创建您的功能分支 (`git checkout -b feature/AmazingFeature`)
3. 提交您的更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 打开 Pull Request
## 📄 许可证
本项目基于 ISC 许可证授权 - 详见 [server/package.json](./server/package.json)。
标签:API安全, Bcrypt, Chart.js, CORS, Express, GNU通用公共许可证, GSAP动画, Helmet, HTTPX, ImageKit, Incident Management, Jest, JSON输出, JWT认证, MITM代理, MongoDB, Mongoose, Morgan, Mutation, Node.js, Nodemailer, OAuth, OISF, Playbook, Rate Limiting, React, RESTful API, SecOps, Syscalls, Tailwind CSS, Vite, WSL, .xyflow/react, 事件管理平台, 云安全架构, 代码示例, 单元测试, 可视化, 响应式设计, 团队协作, 安全事件响应, 安全认证, 安全运营中心, 提示词优化, 数据分析, 文件存储, 日志管理, 流程图, 网络映射, 自定义脚本, 运维监控, 邮件服务