# graphql-server-template

**Repository Path**: ychengcloud/graphql-server-template

## Basic Information

- **Project Name**: graphql-server-template
- **Description**: Heidou graphql server template
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-21
- **Last Updated**: 2021-06-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 特性

- 符合 Golang 设计哲学的工程框架，包括基础功能(JWT, OpenTracing, ZapLog, Promtheus), 参见模板 [graphql-golang-server]()
- 支持查询过滤、排序、分页、指定返回字段、批量查询、批量更新、批量删除
- 依赖注入
- 根据数据库生成对应 CRUD 方法
- 支持 Graphql 文档自动生成
- 框架代码自主可控，初始生成后可根据业务需要灵活修改

- 安全特性
    - JWT
    - CSRF
    - XSS
    - CORS

### TODO
- 针对管理系统和应用的权限配置
- docker-compose


## 项目生成

参见 [Heidou](https://docs.ycheng.pro/heidou)


## 运行项目

项目生成后，根据业务情况修改项目配置文件，即可构建运行

### 安装依赖

- [Make](setup-make.md)
- [Golang 1.16+](https://golang.org/doc/install)
- [Mysql 8.0+](https://dev.mysql.com/doc/refman/8.0/en/installing.html)
- [Heidou 0.1.10+](setup-local.md) 
- [Wire](https://github.com/google/wire)
- [gowatch](https://github.com/silenceper/gowatch) (可选)

### 修改项目配置文件

生成代码后，会生成样例项目配置文件 config/server-example.yaml，根据业务修改

```bash
cp config/server-example.yaml config/server.yaml
```

### 依赖注入

    make wire

### 根据 gqlgen 配置生成 graphql 代码

    make gql_gen

### 编译

    make build

### 启动
    make run

## 运行配置项说明

参见配置文件注释