go-starter

WARNING: This repository is no longer maintained ⚠

Please see the replacement repositories available for Node.js, Go, Java Liberty, Java Spring, Python Flask, Python Django, and Swift.

This repository will not be updated. The repository will be kept available in read-only mode.

Create and deploy a basic Go Gin application

We have similar applications available for Node.js, Java Spring, Swift, Python Flask, and Java Liberty.

In this sample application, you will create a basic web application using Gin to serve web pages in Go, complete with standard best practices, including a health check and application metric monitoring.

Steps

You can deploy this application to IBM Cloud or build it locally by cloning this repo first. Once your app is live, you can access the /health endpoint to build out your cloud native application.

Deploying to IBM Cloud

Use the button above to deploy this same application to IBM Cloud. This option will create a deployment pipeline, complete with a hosted Git lab project and devops toolchain. You will have the option of deploying to either CloudFoundry or a Kubernetes cluster. IBM Cloud DevOps services provides toolchains as a set of tool integrations that support development, deployment, and operations tasks inside IBM Cloud.

Building Locally

To get started building this application locally, you can either run the application natively or use the IBM Cloud Developer Tools for containerization and easy deployment to IBM Cloud.

All of your dep dependencies are stored inside of Gopkg.toml.

Native Application Development

• Install Go
• Install dep

In order for Go applications to run locally, they must be placed in the correct file path. The application must exist in $GOPATH/src/gostarter

Once the Go toolchain has been installed, you can compile a Go project with:

go install

To run your application locally:

dep ensure
go run server.go

Your sources will be compiled to your $GOPATH/bin directory. Your application will be running at http://localhost:8080.

IBM Cloud Developer Tools

Install IBM Cloud Developer Tools on your machine by using the following installation command: curl -sL https://ibm.biz/idt-installer | bash.

Your application will be compiled with Docker containers. To compile and run your app, run:

ibmcloud dev build
ibmcloud dev run

This will launch your application locally. When you are ready to deploy to IBM Cloud on CloudFoundry or Kubernetes, run one of the commands below:

ibmcloud dev deploy -t buildpack
ibmcloud dev deploy -t container

You can build and debug your app locally with:

ibmcloud dev build --debug
ibmcloud dev debug

Next Steps

• Learn more about augmenting your Go applications on IBM Cloud with the Go Programming Guide.
• Explore other sample applications on IBM Cloud.

License

This sample application is licensed under the Apache License, Version 2. Separate third-party code objects invoked within this code pattern are licensed by their respective providers pursuant to their own separate licenses. Contributions are subject to the Developer Certificate of Origin, Version 1.1 and the Apache License, Version 2.

Apache License FAQ