Skip to content

Commit

Permalink
Merge branch 'main' of github.com:penqee/fzuhelper-server into penqee
Browse files Browse the repository at this point in the history
  • Loading branch information
penqee committed Nov 4, 2024
2 parents 983931f + bf91d7b commit d8322cb
Show file tree
Hide file tree
Showing 14 changed files with 1,121 additions and 147 deletions.
8 changes: 0 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ help:
@echo "Available targets:"
@echo " {service name} : Build a specific service (e.g., make api). use BUILD_ONLY=1 to avoid auto bootstrap."
@echo " Available service list: [${SERVICES}]"
@echo " local : Build all services."
@echo " env-up : Start the docker-compose environment."
@echo " env-down : Stop the docker-compose environment."
@echo " kitex-gen-% : Generate Kitex service code for a specific service (e.g., make kitex-gen-user)."
Expand Down Expand Up @@ -129,13 +128,6 @@ ifndef BUILD_ONLY
@tmux select-pane -t fzuhelper-$(service).1
endif

#在本地一键启动所有的服务
.PHONY: local
local:
@ for service in $(SERVICES); do \
make $$service; \
done

# 推送到镜像服务中,需要提前 docker login,否则会推送失败
# 不设置同时推送全部服务,这是一个非常危险的操作
.PHONY: push-%
Expand Down
51 changes: 29 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,28 +24,34 @@ This project focuses on business implementation. To see how we interface with th
## Project structure

```bash
│ .golangci.yml # GolangCI configuration
│ .licenseignore
│ go.mod
│ go.sum
│ LICENSE
│ Makefile # some useful commands
│ README.md
├── cmd # microservices
├── config # for run-directly config and config-example
├── docker # docker build configuration
.
├── .golangci.yml # GolangCI configuration
├── .licenseignore
├── go.mod
├── go.sum
├── LICENSE
├── Makefile # some useful commands
├── README.md
├── api # gateway
├── cmd # microservices entry
├── config # configuration files and examples
├── docker # Docker build configuration
├── docs
├── hack # tools for automating development, build, and deployment tasks.
├── hack # tools for automating development, building, and deployment tasks
├── idl # interface definition
├── internal # microservices implementation
├── kitex_gen # kitex generated code
├── pkg
│ ├── client/ # client side implementations
│ ├── constants/ # store any consts
│ ├── errno/ # custom error
│ ├── logger/ # logging system
│ ├── middleware/ # common middleware
│ ├── tracer/ # for jaeger
│ └── utils/ # useful funcs
└── pkg
├── base/ # common base service
│ └── client/ # client for corresponding components (redis, mysql e.g.)
├── cache/ # cache service
├── db/ # database service
├── constants/ # store any consts
├── errno/ # custom error
├── eshook # elasticsearch hook
├── logger/ # logging system
├── tracer/ # for jaeger
└── utils/ # useful funcs
```

## Quick start and deploy
Expand All @@ -56,13 +62,14 @@ please visit: [deploy](docs/deploy.md)

## Architecture

<img src="/docs/img/architecture.svg">
<img src="./docs/img/architecture.svg">

## Contributors

<img src="/docs/img/logo(en).svg" width="400">
<img src="./docs/img/logo(en).svg" width="400">

If you are interested in joining the maintenance of fzuhelper-server, please contact us on our [official website](https://site.west2.online)

## License
`fzuhelper-server` is under the Apache 2.0 license. See the LICENSE file for details.

`fzuhelper-server` is licensed under the Apache 2.0 license. See the LICENSE file for details.
36 changes: 35 additions & 1 deletion api/handler/api/user_service.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit d8322cb

Please sign in to comment.