parent
a33401da95
commit
8ee476ba9a
@ -1 +1,51 @@
|
||||
# 司机服务
|
||||
# Kratos Project Template
|
||||
|
||||
## Install Kratos
|
||||
```
|
||||
go install github.com/go-kratos/kratos/cmd/kratos/v2@latest
|
||||
```
|
||||
## Create a service
|
||||
```
|
||||
# Create a template project
|
||||
kratos new server
|
||||
|
||||
cd server
|
||||
# Add a proto template
|
||||
kratos proto add api/server/server.proto
|
||||
# Generate the proto code
|
||||
kratos proto client api/server/server.proto
|
||||
# Generate the source code of service by proto file
|
||||
kratos proto server api/server/server.proto -t internal/service
|
||||
|
||||
go generate ./...
|
||||
go build -o ./bin/ ./...
|
||||
./bin/server -conf ./configs
|
||||
```
|
||||
## Generate other auxiliary files by Makefile
|
||||
```
|
||||
# Download and update dependencies
|
||||
make init
|
||||
# Generate API files (include: pb.go, http, grpc, validate, swagger) by proto file
|
||||
make api
|
||||
# Generate all files
|
||||
make all
|
||||
```
|
||||
## Automated Initialization (wire)
|
||||
```
|
||||
# install wire
|
||||
go get github.com/google/wire/cmd/wire
|
||||
|
||||
# generate wire
|
||||
cd cmd/server
|
||||
wire
|
||||
```
|
||||
|
||||
## Docker
|
||||
```bash
|
||||
# build
|
||||
docker build -t <your-docker-image-name> .
|
||||
|
||||
# run
|
||||
docker run --rm -p 8000:8000 -p 9000:9000 -v </path/to/your/configs>:/data/conf <your-docker-image-name>
|
||||
```
|
||||
|
||||
|
@ -1,36 +0,0 @@
|
||||
# Reference https://github.com/github/gitignore/blob/master/Go.gitignore
|
||||
# Binaries for programs and plugins
|
||||
*.exe
|
||||
*.exe~
|
||||
*.dll
|
||||
*.so
|
||||
*.dylib
|
||||
|
||||
# Test binary, built with `go test -c`
|
||||
*.test
|
||||
|
||||
# Output of the go coverage tool, specifically when used with LiteIDE
|
||||
*.out
|
||||
|
||||
# Dependency directories (remove the comment below to include it)
|
||||
vendor/
|
||||
|
||||
# Compiled Object files, Static and Dynamic libs (Shared Objects)
|
||||
*.o
|
||||
*.a
|
||||
*.so
|
||||
|
||||
# OS General
|
||||
Thumbs.db
|
||||
.DS_Store
|
||||
|
||||
# project
|
||||
*.cert
|
||||
*.key
|
||||
*.log
|
||||
bin/
|
||||
|
||||
# Develop tools
|
||||
.vscode/
|
||||
.idea/
|
||||
*.swp
|
@ -1,51 +0,0 @@
|
||||
# Kratos Project Template
|
||||
|
||||
## Install Kratos
|
||||
```
|
||||
go install github.com/go-kratos/kratos/cmd/kratos/v2@latest
|
||||
```
|
||||
## Create a service
|
||||
```
|
||||
# Create a template project
|
||||
kratos new server
|
||||
|
||||
cd server
|
||||
# Add a proto template
|
||||
kratos proto add api/server/server.proto
|
||||
# Generate the proto code
|
||||
kratos proto client api/server/server.proto
|
||||
# Generate the source code of service by proto file
|
||||
kratos proto server api/server/server.proto -t internal/service
|
||||
|
||||
go generate ./...
|
||||
go build -o ./bin/ ./...
|
||||
./bin/server -conf ./configs
|
||||
```
|
||||
## Generate other auxiliary files by Makefile
|
||||
```
|
||||
# Download and update dependencies
|
||||
make init
|
||||
# Generate API files (include: pb.go, http, grpc, validate, swagger) by proto file
|
||||
make api
|
||||
# Generate all files
|
||||
make all
|
||||
```
|
||||
## Automated Initialization (wire)
|
||||
```
|
||||
# install wire
|
||||
go get github.com/google/wire/cmd/wire
|
||||
|
||||
# generate wire
|
||||
cd cmd/server
|
||||
wire
|
||||
```
|
||||
|
||||
## Docker
|
||||
```bash
|
||||
# build
|
||||
docker build -t <your-docker-image-name> .
|
||||
|
||||
# run
|
||||
docker run --rm -p 8000:8000 -p 9000:9000 -v </path/to/your/configs>:/data/conf <your-docker-image-name>
|
||||
```
|
||||
|
Loading…
Reference in new issue