Explorar o código

docs: add dev and ports

luzhenqian %!s(int64=4) %!d(string=hai) anos
pai
achega
82e3d7f0ad
Modificáronse 2 ficheiros con 66 adicións e 0 borrados
  1. 41 0
      docs/dev.md
  2. 25 0
      docs/ports.md

+ 41 - 0
docs/dev.md

@@ -0,0 +1,41 @@
+---
+author: "卢振千"
+createdAt: 2021-02-07
+updatedAt: 2021-05-27
+---
+
+# 开发文档
+
+此文档为开发阶段的开发指南。
+
+## 注意事项
+
+项目不可以在 GO111MODULE 开启的状态下运行。
+
+可以选择将 GO111MODULE 关闭。
+
+```bash
+go env -w GO111MODULE=off
+```
+
+或者临时关闭。
+
+```bash
+export GO111MODULE=off
+```
+
+## 编译服务
+
+首先对项目进行编译。项目中所有需要编译的服务入口都存放在 services/main.go 目录下。
+
+可以运行项目中的 install.sh 脚本进行编译。
+
+编译后的二进制可执行文件会放到 $GOBIN 或者 $GOPATH/bin 目录下。具体会受到系统环境变量配置所影响,比如 $GOARCH 和 $GOOS。
+
+## 启动服务
+
+项目中的所有服务都可以单独启动。也可以通过运行 run.sh 脚本文件批量启动。
+
+每个服务都会依赖一些基础服务组件,首先需要保证这些基础服务组件是否正常。
+
+需要注意 Docker 环境下的基础服务组件和正常环境下的区别。

+ 25 - 0
docs/ports.md

@@ -0,0 +1,25 @@
+---
+author: "卢振千"
+createdAt: 2021-02-07
+updatedAt: 2021-05-27
+---
+
+# 端口分配
+
+开放端口区间为 18100-18200
+
+18100-18120 为平台服务的端口,包括 RPC、HTTP、MQTT 等。
+
+18150-18170 为基础服务组件。
+
+所有业务服务依赖的基础服务组件包括:
+
+- Etcd
+
+- MySQL
+
+- Redis
+
+- RabbitMQ
+
+- pkg 目录下的其它组件