pgxtutorial - GitLite

KO | EN

gitlite — search

#react #llm #go #golang #machine-learning #rust #docker #macos #windows #awesome #cli #ios #mcp #openai

pgxtutorial

(★ 135)

Example of how to build a web service using Go, PostgreSQL, and gRPC

File Explorer

Download Latest Version (.zip)

- - codeql.yml
  - dependency-review.yml
  - integration.yml
  - lint.yml
  - osv-scanner.yml
- dependabot.yml
- FUNDING.yml
- - api.go
  - grpc.go
  - http.go
- - api.proto
  - gen.go
- - database.go
  - database_test.go
  - interface.go
- - helper_test.go
  - inventory.go
  - inventory_test.go
  - mock_db_test.go
  - review.go
  - review_test.go
  - service.go
  - service_test.go
- - helper_test.go
  - postgres.go
  - postgres_test.go
- - telemetry.go
  - telemetry_test.go
- 001_initial_schema.sql
- ci-lint-fmt.sh
- ci-lint.sh
- coverage.sh
go.mod
go.sum
LICENSE.md
main.go
README.md

# Installation Guide

1. Get the code

git clone https://github.com/henvic/pgxtutorial

Downloads the entire project code from GitHub to your computer.

cd pgxtutorial

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Go Go is required to use go install.

go install github.com/henvic/pgxtutorial@latest

Downloads and installs the specified version directly — no need to clone the repo yourself.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Go

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

$ go run .

Runs the Go program directly without a separate build step.

go install github.com/henvic/pgxtutorial@latest

Downloads and installs the specified version directly — no need to clone the repo yourself.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# pgxtutorial
[![GoDoc](https://godoc.org/github.com/henvic/pgxtutorial?status.svg)](https://godoc.org/github.com/henvic/pgxtutorial) [![Build Status](https://github.com/henvic/pgxtutorial/workflows/Integration/badge.svg)](https://github.com/henvic/pgxtutorial/actions?query=workflow%3AIntegration) [![Coverage Status](https://coveralls.io/repos/henvic/pgxtutorial/badge.svg)](https://coveralls.io/r/henvic/pgxtutorial)

This is an accompanying repository of the article [Back to basics: Writing an application using Go and PostgreSQL](https://henvic.dev/posts/go-postgres) by [Henrique Vicente](https://henvic.dev/). Feel free to open issues to ask any questions or comment on anything.

## Environment variables
pgxtutorial uses the following environment variables:

| Environment Variable | Description |
| - | - |
| PostgreSQL environment variables | Please check https://www.postgresql.org/docs/current/libpq-envars.html |
| INTEGRATION_TESTDB | When running go test, database tests will only run if `INTEGRATION_TESTDB=true` |
| OTEL_EXPORTER | When OTEL_EXPORTER=stdout or OTEL_EXPORTER=otel, telemetry is exported |

## tl;dr
To play with it install [Go](https://go.dev/) on your system.
You'll need to connect to a [PostgreSQL](https://www.postgresql.org/) database.
You can check if a connection is working by calling `psql`.

To run tests:

```sh
# Run all tests passing INTEGRATION_TESTDB explicitly
$ INTEGRATION_TESTDB=true go test -v ./...
```

To run application:

```sh
# Create a database
$ psql -c "CREATE DATABASE pgxtutorial;"
# Set the environment variable PGDATABASE
$ export PGDATABASE=pgxtutorial
# Run migrations
$ tern migrate -m ./migrations
# Execute application
$ go run .
2021/11/22 07:21:21 HTTP server listening at localhost:8080
2021/11/22 07:21:21 gRPC server listening at 127.0.0.1:8082
```

You could also
```
go install github.com/henvic/pgxtutorial@latest
```
to just get the `pgxtutorial` binary.

## See also
* [pgtools](https://github.com/henvic/pgtools/)
* [pgq](https://github.com/henvic/pgq)