• Config env prefix (6884cbd)

See #127

• Golang CI
• Go Report Card
• Go Doc
• Build badges (Travis, Circle)

Currently the project does not support multiple binary use cases well:

• make only builds one package
• docker only builds one app
• docker only copies one binary

When running the init script in the boilerplate, import name might break alphabetical order.

This has been fixed for now in #50 , but we should make sure it continues to work in the future as well.

• Check IDE settings
• Write some test/lint rule?

Using the latest go version and the latest main pull, I get the following error:

$ ./init.sh 
? Package name (/home/oipo/Programming/chargepoint/go/modern-go-application) nrg-playground
? Project name (nrg-playground) 
? Binary name (nrg-playground) 
? Application name (nrg-playground) 
? Friendly application name (Nrg Playground) 
? Update README (Y/n) 
? Remove init script (y/N) 
mv: cannot stat '.idea/project.iml': No such file or directory
./init.sh: line 36: .idea/modules.xml.new: No such file or directory
mv: cannot stat '.idea/modules.xml.new': No such file or directory
./init.sh: line 36: .idea/runConfigurations/All_tests.xml.new: No such file or directory
mv: cannot stat '.idea/runConfigurations/All_tests.xml.new': No such file or directory
./init.sh: line 36: .idea/runConfigurations/Debug.xml.new: No such file or directory
mv: cannot stat '.idea/runConfigurations/Debug.xml.new': No such file or directory
./init.sh: line 36: .idea/runConfigurations/Integration_tests.xml.new: No such file or directory
mv: cannot stat '.idea/runConfigurations/Integration_tests.xml.new': No such file or directory
./init.sh: line 36: .idea/runConfigurations/Tests.xml.new: No such file or directory
mv: cannot stat '.idea/runConfigurations/Tests.xml.new': No such file or directory
./init.sh: line 36: .vscode/launch.json.new: No such file or directory
mv: cannot stat '.vscode/launch.json.new': No such file or directory
mv: cannot stat 'cmd/modern-go-application': No such file or directory
find: ‘.gen’: No such file or directory

1. Repeatation
   • Package helloworld contains a function NewHelloWorld.
   • So the client would initialize the HelloWorld type as helloworld.NewHelloWorld which is simply repeatation of the fact that helloworld package contains a HelloWorld and is not recommended Package Names
   • This should instead be helloworld.New()
2. Interfaces
   • Package helloworld contains an interface HelloWorld and function NewHelloWorld returns this interface type instead of concrete type. Interfaces on implementor side as an abstraction has no meaning
   • Package helloworld should contain a concrete type HelloWorld which is returned by helloworld.New function as recommended here
   • Clients who need to use features of HelloWorld type can define interfaces with only the features they really need and inject instance of HelloWorld as an implementation.

Eg. greetingadapter vs adapter. The package name on the other hand should probably keep the unique name.

Use telemetry endpoint instead of a console option.

(Make it configurable? Depend on environment?)

I would like to use this template for my application, however there is no getting started guide or explanations regarding the proper use and extension of this template.

A Getting Started document and a simple overview of the design of the application would really go great lengths in making this more usable IMO.

I was just reviewing the code, and I found a part that looks a little suspect..

https://github.com/sagikazarmark/modern-go-application/blob/master/cmd/modern-go-application/main.go?ts=4#L89

if ReadInConfig does not return an error, then configFileNotFound would be false, right? since the type assert from nil to viper.ConfigFileNotFoundError would fail?

err := v.ReadInConfig()
_, configFileNotFound := err.(viper.ConfigFileNotFoundError)
if !configFileNotFound {
	emperror.Panic(errors.Wrap(err, "failed to read configuration"))
}

# more stuff, including configuring the logger

if configFileNotFound {
	logger.Warn("configuration file not found")
}

it seems like the code will either always panic, or log a warning.

The viper shows the correct way: https://github.com/spf13/viper?ts=4#reading-config-files

if err := viper.ReadInConfig(); err != nil {
    if _, ok := err.(viper.ConfigFileNotFoundError); ok {
        // Config file not found; ignore error if desired
    } else {
        // Config file was found but another error was produced
    }
}

// Config file found and successfully parsed

Additionally, I don't think this is best practice anyway, since a configuration file should not be required if ENV variables are also an alternative. Maybe I'm also reading the code wrong...

This project is a great sandbox for trying out new practices, as well as a great boilerplate for new projects.

As for trying practices, it probably reached a point where the project is "ready", meaning adding new stuff would make it too heavy. Additional service integrations (config) should go into documentation / wiki / website.

Using the project as a boilerplate is not too easy, so this is what I would like to focus on next.

One of the issues is lacking documentation as pointed out in #130.

The other issue is the lack of tooling (code generation, scaffolding).

This is getting better every day in https://github.com/sagikazarmark/mga (especially code generation), but starting a new project is still too hard. So the next step should be a mga new command that creates a new project from the boilerplate. (And we can finally get rid of the crappy init.sh)

Last, but not least we need a better organization of the underlying projects. Right now the boilerplate relies on a few, loosely coupled projects under my account. They need better organization (probably an organization of their own).

Go Buffalo is an excellent example of what I would like to (ideally) achieve with this project.

Add OIDC login flow. Use Dex

Resources:

• https://github.com/qor/auth
• https://connect2id.com/learn/openid-connect
• https://github.com/markbates/goth
• https://oidcdebugger.com/
• https://auth0.com/docs/protocols/oauth2/oauth-state
• https://auth0.com/docs/protocols/oauth2/mitigate-csrf-attacks
• https://stackoverflow.com/questions/35165793/what-prevents-the-state-parameter-in-openid-connect-server-flow
• https://stackoverflow.com/questions/25686484/what-is-intent-of-id-token-expiry-time-in-openid-connect?rq=1
• https://medium.com/@darutk/understanding-id-token-5f83f50fa02e
• https://openid.net/specs/openid-connect-core-1_0.html
• https://github.com/coreos/go-oidc
• https://jacobmartins.com/2016/02/29/getting-started-with-oauth2-in-go/
• https://medium.com/@hfogelberg/the-black-magic-of-oauth-in-golang-part-1-3cef05c28dde
• https://medium.com/@balaajanthan/openid-flow-from-a-cli-ac45de876ead

The current event examples are based on goroutines. Add an example based on RabbitMQ once ThreeDotsLabs/watermill#33 is ready.

They do not contain application specific logic.

The above mentioned configuration needs to be changed either in the jaeger config or the environment variable so that viper properly unmarshalls it into the application configuration
( Field name in the Config struct: CollectorEndpoint, env var name: v.SetDefault("instrumentation.jaeger.endpoint", "http://localhost:14268")

I am happy to push the PR if this is valid ...

Could you please share reasons why you decided to use MySQL for this project?

There is a folder .gen/api/openapi with generated code. I do not see it's used somewhere. What it is for? Could you please suggest a way how to use it ?

The application was generated with

? Package name (/home/dima/develop/go-app1) github.com/dmdv/go-app1
? Project name (go-app1) 
? Binary name (go-app1) 
? Application name (go-app1) 
? Friendly application name (Go App1) Modern Go Application
? Update README (Y/n) Y
? Remove init script (y/N) n

When I tried to sync dependencies, I got the following error

go: finding module for package github.com/dmdv/go-app1/internal/app/go-app1
go: finding module for package github.com/dmdv/go-app1/internal/app/go-app1/todo/tododriver
github.com/dmdv/go-app1/cmd/go-app1 imports
	github.com/dmdv/go-app1/internal/app/go-app1: no matching versions for query "latest"
github.com/dmdv/go-app1/cmd/go-app1 imports
	github.com/dmdv/go-app1/internal/app/go-app1/todo/tododriver: no matching versions for query "latest"
github.com/dmdv/go-app1/internal/app/mga imports
	github.com/sagikazarmark/todobackend-go-kit/todo/tododriver imports
	github.com/sagikazarmark/todobackend-go-kit/internal/.generated/api/v1/graphql: malformed import path "github.com/sagikazarmark/todobackend-go-kit/internal/.generated/api/v1/graphql": leading dot in path element
github.com/dmdv/go-app1/internal/app/mga imports
	github.com/sagikazarmark/todobackend-go-kit/todo/tododriver imports
	github.com/sagikazarmark/todobackend-go-kit/internal/.generated/api/v1/rest/go: malformed import path "github.com/sagikazarmark/todobackend-go-kit/internal/.generated/api/v1/rest/go": leading dot in path element

And script generation completed with an error

The overall impression is that the template has never been tested and too much stuffed with the extra unnecessary functionality

it looks like this image got removed from the docker hub

Pulling oc-collector (omnition/opencensus-collector:0.1.10)...
ERROR: The image for the service you're trying to recreate has been removed. If you continue, volume data could be lost. Consider backing up your data before continuing.

Currently MySQL install fails because the mysql chart requires mysql-password in the existing secret.

Business errors should not be logged as errors.

Thanks for this awesome project.

Before I came into this project, I have no experience of gokit.
I want to use this project to learn gokit and start my first gokit project.
Is there any tutorial or more detailed document for gokit beginner to do things like steps of creating new service etc.

Best regards.

During gitlab pipelines app is built twice

• snapshot stage
• packaging stage
  Is there any specific reason behind that ?

I love using https://github.com/ldez/seihon for multi-arch docker builds. Adding https://goreleaser.com might be another addition, though both are on the build, less on the code side. And golangci-lint and...

Open Census?

Check out OPA

Keep the current TODO API for simplicity? Or create a new API with protected resources?

Hi @sagikazarmark
I am an open source enthusiast and I am looking to expand my work portfolio.
I would like to collaborate with your project for free, I can provide you with a logo for your project

Good day
Skull C.

Any possible to support Windows?

When trying to delete helm releases, mysql jobs don't get deleted.

A Spotguide is a collection of deployable applications and services. A Spotguide is a wizard to create a Git repository, set up CI/CD, create a Kubernetes cluster and deploy the application(s). It’s built upon Helm, but provides additional integration with Banzai Cloud Pipeline.

More information about Spotguides:

https://beta.banzaicloud.io/docs/spotguide/introduction/
https://banzaicloud.com/blog/spotguides-revisited/
https://banzaicloud.com/tags/spotguides/

Banzai Cloud Pipeline is in public beta: