Skip to content

Commit 5c97f32

Browse files
committed
update mono repo: go-zero
1 parent 3924c19 commit 5c97f32

File tree

1 file changed

+45
-40
lines changed

1 file changed

+45
-40
lines changed

readme.md

Lines changed: 45 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,28 @@
22
# cookiecutter-go
33

44
- boilerplate, go project starter.
5-
- go 微服务项目目录生成工具.
6-
- feature:
7-
- [x] `mono repo`: 支持创建 `mono repo`, git 项目根目录.
8-
- [x] [go-zero](https://github.com/tal-tech/go-zero)
9-
- [x] [gin](https://github.com/gin-gonic/gin)
10-
- [x] [go-micro](https://github.com/asim/go-micro)
11-
- [x] `single app`: 支持创建 `single app`, 单个微服务目录.
12-
- [x] [go-zero](https://github.com/tal-tech/go-zero)
13-
- [x] [gin](https://github.com/gin-gonic/gin)
14-
- [x] [go-micro](https://github.com/asim/go-micro)
15-
- [x] 可单个使用, 也可同时组合使用
5+
- [x] go 微服务(`go-zero/gin/go-micro`)项目目录生成工具/脚手架.
6+
- [x] 基于 [cookiecutter](https://github.com/cookiecutter/cookiecutter) 实现.
7+
8+
9+
10+
## Feature:
11+
12+
13+
- [x] `mono repo`: 支持创建 `mono repo`, git 项目根目录.
14+
- [x] [go-zero](https://github.com/tal-tech/go-zero)
15+
- [x] [gin](https://github.com/gin-gonic/gin)
16+
- [x] [go-micro](https://github.com/asim/go-micro)
17+
- [x] `single app`: 支持创建 `single app`, 单个微服务目录.
18+
- [x] [go-zero](https://github.com/tal-tech/go-zero)
19+
- [x] [gin](https://github.com/gin-gonic/gin)
20+
- [x] [go-micro](https://github.com/asim/go-micro)
21+
- [x] 可单个使用, 也可同时组合使用
1622
- usage:
1723
- [x] 先创建 `mono-repo` 根目录
1824
- [x] 切换到 `app/` 下, 创建 `single app` 单个微服务目录.
19-
- require:
20-
- [x] 基于 [cookiecutter](https://github.com/cookiecutter/cookiecutter) 实现.
21-
2225

23-
## feature:
26+
### Intro:
2427

2528
- `go-zero` 微服务:
2629
- [x] 集成 air 工具, watch 项目代码, `自动编译 + hot reload`, 让 go 开发更丝滑(类 Python/Js)
@@ -46,15 +49,15 @@
4649
- [x] log: 集成 uber log
4750
- [x] db: 集成 gorm + mysql
4851

49-
## 应用案例:
52+
## User Case:
5053

5154
- [x] https://github.com/zeromicro/zeromall
5255
- 基于 go-zero 的微服务`B2B2C电商平台`
5356

5457

55-
## quickstart:
58+
## Quick Start:
5659

57-
### install:
60+
### Install:
5861

5962
- https://cookiecutter.readthedocs.io/en/1.7.2/installation.html
6063

@@ -68,7 +71,7 @@ sudo apt-get install cookiecutter
6871

6972
```
7073

71-
### best practice:
74+
### Best Practice:
7275

7376

7477
- [x] choice 1: create `mono-repo` + `single-app`
@@ -79,9 +82,9 @@ sudo apt-get install cookiecutter
7982
- [x] choice 2: create `library-repo`
8083

8184

82-
#### 1. mono-repo + single-app
85+
#### 1. Mono-Repo + Single-App
8386

84-
- 1.1 create mono repo:
87+
- 1.1 create `mono repo`:
8588

8689

8790
> git repo / project root.
@@ -108,7 +111,7 @@ cookiecutter https://github.com/better-go/cookiecutter-go.git --directory="mono-
108111
```
109112

110113

111-
- 1.2 create single app folder:
114+
- 1.2 create `single app` folder:
112115

113116
```bash
114117

@@ -146,8 +149,9 @@ cookiecutter https://github.com/better-go/cookiecutter-go.git --directory="libra
146149

147150

148151

149-
## mono repo structure:
152+
## Generate Project Folder Structure:
150153

154+
- [x] Mono Repo:
151155

152156
```bash
153157

@@ -216,7 +220,7 @@ cookiecutter https://github.com/better-go/cookiecutter-go.git --directory="libra
216220
```
217221

218222

219-
## single app structure:
223+
- [x] single app:
220224

221225

222226
```bash
@@ -241,16 +245,29 @@ cookiecutter https://github.com/better-go/cookiecutter-go.git --directory="libra
241245
```
242246

243247

244-
## cookiecutter docs:
248+
## Reference:
249+
250+
- https://github.com/audreyr/cookiecutter-pypackage
251+
- https://github.com/pydanny/cookiecutter-django
252+
- https://github.com/pydanny/cookiecutter-django/blob/master/cookiecutter.json
253+
- https://github.com/golang-standards/project-layout
254+
- https://github.com/micro/micro
255+
- https://github.com/micro/micro/blob/master/client/cli/new/new.go
256+
- https://github.com/adobe/go-starter
257+
- https://github.com/gatsbyjs/gatsby-starter-default
258+
259+
260+
261+
### cookiecutter docs:
245262

246263
- https://github.com/cookiecutter/cookiecutter
247264
- `项目脚手架`的脚手架
248265

249-
### install:
266+
> install:
250267
251268
- https://cookiecutter.readthedocs.io/en/1.7.2/installation.html
252269

253-
### multi template:
270+
> multi template:
254271
255272
- https://cookiecutter.readthedocs.io/en/1.7.2/advanced/directories.html
256273
- 支持一个 git 下, 存放多个`目录创建模板`.
@@ -262,7 +279,7 @@ cookiecutter https://github.com/user/repo-name.git --directory="directory1-name"
262279

263280
```
264281

265-
### create a template:
282+
> create a template:
266283
267284

268285
- https://cookiecutter.readthedocs.io/en/1.7.2/first_steps.html
@@ -292,15 +309,3 @@ mkdir {{cookiecutter.repo_name}}
292309

293310
```
294311

295-
296-
297-
## ref:
298-
299-
- https://github.com/audreyr/cookiecutter-pypackage
300-
- https://github.com/pydanny/cookiecutter-django
301-
- https://github.com/pydanny/cookiecutter-django/blob/master/cookiecutter.json
302-
- https://github.com/golang-standards/project-layout
303-
- https://github.com/micro/micro
304-
- https://github.com/micro/micro/blob/master/client/cli/new/new.go
305-
- https://github.com/adobe/go-starter
306-
- https://github.com/gatsbyjs/gatsby-starter-default

0 commit comments

Comments
 (0)