Codebase

Navigate the Codebase using the tree view. Use the filters to highlight where various files are grouped to aid understanding.

Getting Started Commands

docker build -t golang-demo .: Build a Docker image named “golang-demo” from the current directory [1]

docker run --name=golang-http-demo -p 8082:8080 -itd golang-demo: Run the “golang-demo” Docker image in a container named “golang-http-demo”, map port 8082 to 8080 inside the container, and run the container in detached mode [1][2]

go test: Run tests for the Go application [3]

docker run --name=golang-http-demo-prod -p 8080:8080 -itd golang-demo: Run the “golang-demo” Docker image in a container named “golang-http-demo-prod”, map port 8080 to 8080 inside the container, and run the container in detached mode [1][2]

curl localhost:8082: Send an HTTP request to the running container and display the response [4]

[1] https://docs.docker.com/engine/reference/commandline/build/

[2] https://docs.docker.com/engine/reference/commandline/run/

[3] https://golang.org/doc/effective_go.html#testing

[4] https://curl.se/libcurl/

[5] https://curl.se/docs/manpage.html#CURLOPT_URL

Project Structure

Below is a short description of the key directories of the project to aid you when understanding where key files are located.

app.go - This is the main Go file for the application. It contains the entry point and the main logic of the program [3].

Dockerfile - A Dockerfile is a text document that contains all the commands a user could call on the command line to assemble an image. It allows for the automation of building, running, and testing of software in a containerized environment [1].

go.mod - go.mod is a file that Go uses to manage dependencies for a Go module. It specifies the modules that the application depends on and their versions [4].

go.sum - go.sum is a file that Go uses to verify the integrity of downloaded packages. It contains the expected SHA256 checksums for all the packages that the application depends on [5].

README.md - A README file is a document that provides information about a project. It usually includes a description of what the project does, how to install and use it, and any other important details [2]. In this case, it is written in Markdown format.

Entrypoints

Below are files we identified as entrypoints for to the codebase. This is where the application starts and a good place to start when learning.

app.go - This is the main entrypoint of the application. It contains the `main` function, which initializes the application and starts the server when run. It also defines the `HelloWorld` function, which is a simple handler function for returning a greeting message.

Codebase

Getting Started Commands

Project Structure

Entrypoints

Explanation

Graph

Symbols

Entrypoints