https://github.com/henrywhitaker3/connect-template

https://github.com/henrywhitaker3/connect-template

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/henrywhitaker3/connect-template
• Owner: henrywhitaker3
• Created: 2024-10-13T00:23:44.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-08T19:10:33.000Z (about 1 month ago)
• Last Synced: 2024-11-08T20:20:33.028Z (about 1 month ago)
• Language: Go
• Size: 290 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Go Template

A template repo for golang APIs, comes with:

- YAML configs

- Postgres db connection

- Atlas/golang-migrate migrations

- Metrics server

- Probes server

- HTTP server

- Test containers setup

- SQLC

- OpenTelemetry Tracing

- Sentry error tracking

- User creation/JWT authentication

- S3/Filesystem storage

- Pryoscope profiling

## Get Started

First, create a new repo from the template, then run:

```

./hack/rename.sh

```

and follow the promts to rename the go module etc.

Then copy the example config file:

```

cp api.example.yaml api.yaml

```

The config file comes with a pre-generated JWT secret and encryption key, you should generate new secrets with:

```

task jwt:secret

task encryption:key

```

## Running Tests

On every PR, the Dockerfile will be built and unit tests will be run, you can run these manually with:

```

task build

```

```

task test:unit

```