Skip to content

Commit

Permalink
feat: 快速开始
Browse files Browse the repository at this point in the history
  • Loading branch information
dapeng committed Apr 28, 2024
1 parent f555692 commit 8403a88
Show file tree
Hide file tree
Showing 5 changed files with 71 additions and 38 deletions.
61 changes: 30 additions & 31 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,39 +29,38 @@ module.exports = {
selectText: '选择语言',
editLinkText: '在 GitHub 上编辑此页',

// nav: [
// {
// text: '指南',
// link: '/zh/guide/'
// },

// {
// text: '快速开始',
// link: '/zh/quick-start/'
// },
// {
// text: 'Web开发',
// link: '/zh/web/',
// },
nav: [
{
text: '介绍',
link: '/zh/'
},
{
text: '快速开始',
link: '/zh/quick-start/'
},
// {
// text: 'Web开发',
// link: '/zh/web/',
// },

// {
// text: 'API 参考',
// link: '/zh/api/'
// },
// {
// text: '故事',
// link: '/zh/story/'
// }, {
// text: 'Goner 组件库',
// link: '/zh/goners/'
// },
// ],
// {
// text: 'API 参考',
// link: '/zh/api/'
// },
// {
// text: '故事',
// link: '/zh/story/'
// }, {
// text: 'Goner 组件库',
// link: '/zh/goners/'
// },
],

// sidebar: [
// ['/zh/', '介绍'],
// '/zh/quick-start/',
// '/zh/guide/',
// ],
sidebar: [
['/zh/', '介绍'],
'/zh/quick-start/',
// '/zh/guide/',
],
},

'/en/': {
Expand Down
Binary file added docs/img/image3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/image4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 1 addition & 5 deletions docs/zh/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
---
sidebar: auto
---

# Gone 框架介绍
# 介绍

## Gone是什么
Gone是一个为熟悉Spring的程序员设计的Golang框架,它整合了依赖注入和Web功能,使得在Golang中的应用程序管理和开发更加方便。该框架定义了像“Goners”(组件)、“Cemetery”(存储)和“Heaven”(运行状态)等概念,每一个都在生命周期管理和依赖处理中发挥着独特的作用。它支持依赖注入、服务生命周期管理和动态属性注入等功能,以改善开发体验。
Expand Down
42 changes: 40 additions & 2 deletions docs/zh/quick-start/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,43 @@ sidebar: auto

# 快速开始

## 安装工具
## 创建项目
## 安装gone辅助工具
```bash
go install github.com/gone-io/gone/tools/gone@latest
```

> 安装可以使用gone命令:
> ```bash
> gone -h
> ```
> ![gone 命令结果](../../img/image3.png)
> 支持的功能:
> 1. create,创建一个gone app,暂时只支持创建web app
> 2. priest,为项目自动生成 **Priest** 函数,[了解更多](../)
> 3. 生成用于测试的mock代码
## 创建一个web项目并运行代码
```bash
# 创将一个名为 web-app 的项目
gone create web-app
cd web-app
make run
```
## 项目结构
![项目结构](../../img/image4.png)

- cmd/server/main.go: 启动文件,main函数所在文件
- config/: 项目配置文件目录,支持`.properties`文件
- internal/router/: 在该目录定义路由器
- internal/middleware/: 中间件目录,如果需要定义web中间件,在该目录编写
- internal/controller/: controller目录,在该目录中的文件定义路由
- internal/interface/service/: 该目录放服务的接口定义
- internal/domain/: 该目录放领域对象
- internal/entity/: 该目录放一些无逻辑的结构体,类似于Java 的POJO
- internal/module/: 模块目录,下面的每一个子目录实现一个模块的功能,一般是internal/interface/service/中定义的服务的业务实现;
- internal/pkg/: 在该目录可以放一些项目共用的工具代码
- internal/master.go: 存放**MasterPriest**函数
- internal/priest.go: gone priest 命令生成的 **Priest**函数,用于**埋葬**所有Goner

## 业务启动流程

0 comments on commit 8403a88

Please sign in to comment.