This is a skeleton project for a go application, espeically web application, which captures the best practise including:
-
following suggested project layout
cmd,internaland easy to extend.
there are some discussions about ifpkgshould be used, see issue #1. if you prefer less folder nest, please ignore it; if you want your main folder more clean, you can use it. -
uses a makefile to drive the build and a dockerfile to build a docker image.
-
uses
embedto package web resources to one binary file
folder structure:
go-starter
└── web -- web app，here use vitejs + vue3 for example
├── dist -- product build output
├── build.go -- embed.FS
├── ...
└── cmd
├── main.go -- backend enry，here use gin for exmple
├── ...
-
git clone https://github.com/feitian124/go-starter
-
build web
cd web/
yarn
yarn build
cd ..this will generate web product build to web/dist
- start go server, including the web!
± |main ✓| → go run cmd/app/main.go
[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.
[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
- using env: export GIN_MODE=release
- using code: gin.SetMode(gin.ReleaseMode)
[GIN-debug] GET /assets/*filepath --> github.com/gin-gonic/gin.(*RouterGroup).createStaticHandler.func1 (3 handlers)
[GIN-debug] HEAD /assets/*filepath --> github.com/gin-gonic/gin.(*RouterGroup).createStaticHandler.func1 (3 handlers)
[GIN-debug] GET / --> main.setupRouter.func1 (3 handlers)
[GIN-debug] Listening and serving HTTP on :8080
To use this, simply copy these files and make the following changes:
Makefile:
- change
BINSto your binary name(s) - replace
cmd/myapp-*with one directory for each of yourBINS - change
REGISTRYto the Docker registry you want to use - maybe change
SRC_DIRSif you use some other layout - choose a strategy for
VERSIONvalues - git tags or manual
Dockerfile.in:
- maybe change or remove the
USERif you need
Run make or make build to compile your app. This will use a Docker image
to build your app, with the current directory volume-mounted into place. This
will store incremental state for the fastest possible build. Run make all-build to build for all architectures.
Run make container to build the container image. It will calculate the image
tag based on the most recent git tag, and whether the repo is "dirty" since
that tag (see make version). Run make all-container to build containers
for all supported architectures.
Run make push to push the container image to REGISTRY. Run make all-push
to push the container images for all architectures.
Run make clean to clean up.
Run make help to get a list of available targets.