Skip to content

Commit fee87fb

Browse files
authored
Create README.md
1 parent 3fb76ba commit fee87fb

File tree

1 file changed

+74
-0
lines changed

1 file changed

+74
-0
lines changed

README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
## 项目简介
2+
3+
sdlc 是一个基于 Go 语言构建的安全漏洞管理平台,旨在促进 DevSecOps 和安全开发生命周期 (SDLC) 实践。它通过模拟常见漏洞来增强开发人员的安全意识,并提供了一个实践和学习的环境。本项目采用了前后端分离的设计模式,其中后端利用了轻量级框架 Gin,而前端则使用了 Vue 3。
4+
5+
## 主要特性
6+
7+
- **前后端分离**:后端处理业务逻辑,前端负责用户交互。
8+
- **轻量高效**:使用 Gin 框架,确保高并发下的性能稳定。
9+
- **未来扩展**:计划集成静态应用安全测试 (SAST) 功能。
10+
11+
## 技术栈
12+
13+
- **后端**: Go (Gin 框架)
14+
- **前端**: Vue 3
15+
16+
## 安装与运行
17+
18+
1. 下载最新版本的发布包
19+
2. 运行发布包中的start.bat
20+
3. 在web登录界面输入账号:user1,密码:hello
21+
### 系统需求
22+
23+
- 支持的操作系统: Windows x86
24+
- 计划支持: Linux, ARM 架构
25+
26+
## Project Description
27+
28+
`sdlc` is a security vulnerability management platform built with the Go language, aimed at promoting DevSecOps and Secure Development Lifecycle (SDLC) practices. It enhances developers' security awareness by simulating common vulnerabilities and provides an environment for practice and learning. This project employs a separation of frontend and backend design pattern, where the backend leverages the lightweight Gin framework, and the frontend uses Vue 3.
29+
30+
## Key Features
31+
32+
- **Separation of Frontend and Backend**: The backend handles business logic, while the frontend manages user interaction.
33+
- **Lightweight and Efficient**: Uses the Gin framework to ensure stable performance under high concurrency.
34+
- **Future Expansion**: Plans to integrate Static Application Security Testing (SAST) functionality.
35+
36+
## Technology Stack
37+
38+
- **Backend**: Go (Gin Framework)
39+
- **Frontend**: Vue 3
40+
41+
## Installation and Running
42+
43+
1. Download the latest release package.
44+
2. Run the `start.bat` file in the release package.
45+
3. Enter the account: `user1`, password: `hello` on the web login page.
46+
### System Requirements
47+
48+
- Supported operating systems: Windows x86
49+
- Planned support: Linux, ARM architecture
50+
51+
## プロジェクトの説明
52+
53+
`sdlc`はGo言語で構築されたセキュリティ脆弱性管理プラットフォームであり、DevSecOpsおよびセキュアな開発ライフサイクル(SDLC)の実践を促進することを目指しています。一般的な脆弱性をシミュレートすることで開発者のセキュリティ意識を強化し、実践と学習の環境を提供します。このプロジェクトでは、フロントエンドとバックエンドを分離する設計パターンが採用されており、バックエンドは軽量フレームワークのGinを利用し、フロントエンドはVue 3を使用しています。
54+
55+
## 主な機能
56+
57+
- **フロントエンドとバックエンドの分離**:バックエンドはビジネスロジックを処理し、フロントエンドはユーザーとの対話を担当します。
58+
- **軽量かつ効率的**:Ginフレームワークを使用して、高負荷時のパフォーマンスを安定させます。
59+
- **将来の拡張性**:スタティック アプリケーション セキュリティ テスト(SAST)機能を統合する予定です。
60+
61+
## テクノロジースタック
62+
63+
- **バックエンド**: Go (Gin フレームワーク)
64+
- **フロントエンド**: Vue 3
65+
66+
## インストールと実行
67+
68+
1. 最新のリリースパッケージをダウンロードしてください。
69+
2. リリースパッケージ内の`start.bat`を実行してください。
70+
3. ウェブログイン画面でアカウント: `user1`、パスワード: `hello`を入力してください。
71+
### システム要件
72+
73+
- 対応しているオペレーティングシステム: Windows x86
74+
- 今後の対応予定: Linux, ARM アーキテクチャ

0 commit comments

Comments
 (0)