mirror of
https://github.com/veops/oneterm.git
synced 2025-09-26 19:31:14 +08:00
docs: add Development section to README with quick setup guide
This commit is contained in:
@@ -37,7 +37,7 @@ For new feature additions, please first contact us directly via the contact info
|
||||
+ Please follow the [Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
|
||||
|
||||
+ Commit with different scopes
|
||||
- API: `feat(api): xxx`
|
||||
- API: `feat(backend): xxx`
|
||||
- UI: `feat(ui): xxx`
|
||||
|
||||
+ Please keep the commit message in English for better understanding by all developers.
|
||||
|
@@ -37,7 +37,7 @@
|
||||
+ 请遵循 [Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
|
||||
|
||||
+ 提交时使用不同的范围
|
||||
- API: `feat(api): xxx`
|
||||
- API: `feat(backend): xxx`
|
||||
- UI: `feat(ui): xxx`
|
||||
|
||||
+ 为了确保所有开发者都能更好地理解,提交信息请使用英文。
|
||||
|
30
README.md
30
README.md
@@ -119,6 +119,30 @@ Star us, and you will receive all releases notifications from GitHub without any
|
||||
- Username: admin
|
||||
- Password: 123456 (default) or your custom password if using setup.sh
|
||||
|
||||
## Development
|
||||
|
||||
For developers who want to contribute to OneTerm or set up a local development environment:
|
||||
|
||||
### 🚀 Quick Development Setup
|
||||
```bash
|
||||
# Clone repository
|
||||
git clone https://github.com/veops/oneterm.git
|
||||
cd oneterm/deploy
|
||||
|
||||
# Frontend development (live editing)
|
||||
./dev-start.sh frontend
|
||||
|
||||
# Backend development (live editing)
|
||||
./dev-start.sh backend
|
||||
|
||||
```
|
||||
|
||||
### 📖 Detailed Development Guide
|
||||
For complete setup instructions, troubleshooting, and development workflows:
|
||||
- **[Development Environment Setup Guide](deploy/dev_readme.md)**
|
||||
|
||||
**Requirements**: Docker, Node.js 14.17.6+, Go 1.21.3+
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome all developers to contribute code to improve and extend this project. Please read our [contribution guidelines](CONTRIBUTING.md) first. Additionally, you can support Veops open source through social media, events, and sharing.
|
||||
@@ -131,9 +155,3 @@ We welcome all developers to contribute code to improve and extend this project.
|
||||
- [CMDB](https://github.com/veops/cmdb): Simple, lightweight, and versatile operational CMDB
|
||||
- [ACL](https://github.com/veops/acl): A general permission control management system.
|
||||
- [messenger](https://github.com/veops/messenger): A simple and lightweight message sending service.
|
||||
|
||||
## Community
|
||||
|
||||
+ Email: <a href="mailto:bd@veops.cn">bd@veops.cn</a>
|
||||
+ WeChat official account: Welcome to follow our WeChat official account and join our group channels
|
||||
<img src="docs/images/wechat.png" alt="WeChat official account" />
|
24
README_cn.md
24
README_cn.md
@@ -123,6 +123,30 @@ OneTerm 是一款简单、轻量、灵活的企业级堡垒机产品,基于4A
|
||||
- 账号: admin
|
||||
- 密码: 123456(默认)或使用setup.sh时设置的自定义密码
|
||||
|
||||
## 开发环境
|
||||
|
||||
为希望贡献代码或搭建本地开发环境的开发者提供:
|
||||
|
||||
### 🚀 快速开发环境搭建
|
||||
```bash
|
||||
# 克隆代码库
|
||||
git clone https://github.com/veops/oneterm.git
|
||||
cd oneterm/deploy
|
||||
|
||||
# 前端开发(实时编辑)
|
||||
./dev-start.sh frontend
|
||||
|
||||
# 后端开发(实时编辑)
|
||||
./dev-start.sh backend
|
||||
|
||||
```
|
||||
|
||||
### 📖 详细开发指南
|
||||
完整的环境搭建说明、故障排除和开发流程:
|
||||
- **[开发环境搭建指南](deploy/dev_readme.zh.md)**
|
||||
|
||||
**环境要求**: Docker, Node.js 14.17.6+, Go 1.21.3+
|
||||
|
||||
## 代码贡献
|
||||
我们欢迎所有开发者贡献代码,改善和扩展这个项目。请先阅读我们的[贡献指南](CONTRIBUTING_cn.md)。此外,您还可以通过社交媒体、活动和分享来支持 Veops 的开源。
|
||||
|
||||
|
Reference in New Issue
Block a user