This is my boilerplate for a Go http server project. Feedback and suggestions are encouraged!

Go to file

Jeffrey Paul dd778174a7 Some checks failed continuous-integration/drone/push Build is failing Details sneak/integrate-di (#17 ) moving this to use uber/fx di framework instead of the ad hoc di setup before Co-authored-by: sneak <sneak@sneak.berlin> Reviewed-on: #17		2023-01-29 03:06:05 +00:00
cmd/httpd	sneak/integrate-di (#17 )	2023-01-29 03:06:05 +00:00
internal	sneak/integrate-di (#17 )	2023-01-29 03:06:05 +00:00
static	embed static files now (#14 )	2022-11-28 00:19:47 +00:00
templates	sneak/integrate-di (#17 )	2023-01-29 03:06:05 +00:00
.dockerignore	now supports remote error reporting to sentry, if desired	2020-09-30 21:59:20 -07:00
.drone.yml	fix	2022-11-28 02:57:32 +01:00
.gitignore	sneak/integrate-di (#17 )	2023-01-29 03:06:05 +00:00
Dockerfile	fix	2022-11-28 02:57:32 +01:00
go.mod	sneak/integrate-di (#17 )	2023-01-29 03:06:05 +00:00
go.sum	sneak/integrate-di (#17 )	2023-01-29 03:06:05 +00:00
LICENSE	initial	2020-09-29 23:35:07 -07:00
Makefile	embed static files now (#14 )	2022-11-28 00:19:47 +00:00
README.md	update README	2020-10-10 15:17:17 +00:00

README.md

gohttpserver

This is my boilerplate for a go HTTP server, designed to be a starting point template for new projects, with most things conveniently stubbed out and ready for simple and fast customization, with sane defaults.

Many ideas are taken from Mat Ryer's talk titled "How I Write HTTP Web Services after Eight Years" at GopherCon 2019, seen here:

https://www.youtube.com/watch?v=rWBSMsLG8po

Contributing

Contributions are welcome! Please send me an email if you'd like an account on this server to submit PRs.

Alternately, even just feedback is great: sneak@sneak.berlin

Features

Basic logging middleware
Stub Authentication middleware
Helper functions for encoding/decoding json
Healthcheck route
Prometheus metrics endpoint
No global state of our own
- some deps have some, such as the metrics collector and Sentry

Design Decisions

no TLS in this code
- do it somewhere else, like on a sidecar or reverse proxy
- this might have to change to support http > 1 later
logging: rs/zerolog
configuration: spf13/viper
- used as a wrapper around env vars, because of typed getters
router is Chi: go-chi/chi
Prometheus-style metrics via slok/go-http-metrics
code formatted with mvdan.cc/gofumpt
code style checked with golangci/golangci-lint

Pending Design Decisions

database: TBD (thinking about go-gorm/gorm)
templating: TBD (suggestions welcome)

TODO

Basic HTML Templates
Database Boilerplate
Sessions Middleware
sync.Once example for re-compiling templates
Bundling static assets into binary

Known Bugs (more TODO)

Chi recovery middleware logs non-json when in non-tty stdout mode, breaking validity of stdout as a json stream

Author

License

WTFPL (aka public domain):

            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
                    Version 2, December 2004

 Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>

 Everyone is permitted to copy and distribute verbatim or modified
 copies of this license document, and changing it is allowed as long
 as the name is changed.

            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. You just DO WHAT THE FUCK YOU WANT TO.