/modlib

Go project layout with exported packages and command-line tools, using modules

Primary LanguageGoThe UnlicenseUnlicense

Demonstrates the structure of a Go module on GitHub, with multiple packages and command-line tools.

For more details see https://eli.thegreenplace.net/2019/simple-go-project-layout-with-modules/

To use packages from this module in your code, add an import:

import "github.com/eliben/modlib"
import "github.com/eliben/modlib/clientlib"

// ... later
s := modlib.Config()
h := clientlib.Hello()

To use the modlib-server binary, do:

$ go install github.com/eliben/modlib/cmd/modlib-server@latest
$ modlib-server

To build this binary from source locally, do:

$ go build ./cmd/modlib-server

All packages in this module are importable by other modules, except for packages located in the internal directory. These can be used from within the module itself, but cannot be imported from the outside.

To run all tests in this module:

go test ./...

If you have questions about applyinig this approach, feel free to open a GitHub issue.