This repository will not be updated. The repository will be kept available in read-only mode.
We have applications available for Node.js Express, Go Gin, Python Flask, Python Django, Java Spring, Java Liberty, Swift Kitura, Android, and iOS.
In this sample web application, you will create a Go cloud application using Gin. This application contains an opinionated set of files for web serving:
public/index.html
public/404.html
public/500.html
This application also enables a starting place for a Go microservice using Gin. A microservice is an individual component of an application that follows the microservice architecture - an architectural style that structures an application as a collection of loosely coupled services, which implement business capabilities. The microservice exposes a RESTful API matching a Swagger definition.
IBM Cloud DevOps services provides toolchains as a set of tool integrations that support development, deployment, and operations tasks inside IBM Cloud.
Also, this application comes with the following capabilities:
- Swagger UI running on:
/explorer
- An OpenAPI 2.0 definition hosted on:
/swagger/api
- A Healthcheck:
/health
To get started building this web 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 go
dependencies are listed in go.mod
.
- Install Go
In order for Go applications to run anywhere including your $GOPATH/src
export GO111MODULE=on
Fetch and install dependencies listed in go.mod:
go build ./...
To run your application locally:
go run server.go
Your sources will be compiled to your $GOPATH/bin
directory. Your application will be running at https://localhost:8080
. You can also verify the state of your locally running application using the Selenium UI test script included in the scripts
directory.
Install IBM Cloud Developer Tools on your machine by running the following command:
curl -sL https://ibm.biz/idt-installer | bash
Create an application on IBM Cloud by running:
ibmcloud dev create
This will create and download a starter application with the necessary files needed for local development and deployment.
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 Kubernetes, run one of the commands:
ibmcloud dev deploy -t container // to K8s cluster
You can build and debug your app locally with:
ibmcloud dev build --debug
ibmcloud dev debug
This repository includes a .cra/.cveignore
file that is used by Code Risk Analyzer (CRA) in IBM Cloud Continuous Delivery. This file helps address vulnerabilities that are found by CRA until a remediation is available, at which point the vulnerabilities will be addressed in the respective package versions. CRA keeps the code in this repository free of known vulnerabilities, and therefore helps make applications that are built on this code more secure. If you are not using CRA, you can safely ignore this file.
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.