sneak
/
gohttpserver
1
0
Fork 0
Code Issues 5 Pull Requests 1 Releases Wiki Activity
This is my boilerplate for a Go http server project. Feedback and suggestions are encouraged!
23 Commits 2 Branches 0 Tags 450 KiB
Go 67.8%
HTML 25.3%
Makefile 2.8%
Dockerfile 2.1%
CSS 2%
Go to file
Jeffrey Paul cd99564268
continuous-integration/drone/push Build is passing Details
Merge branch 'newrouter' of sneak/gohttpserver into master, fixes #1 		2020-10-03 07:03:56 +00:00
cmd/httpd fixed gitignore which mistakenly omitted the cmd dir 2020-09-30 01:28:06 -07:00
httpserver format comments better 2020-10-02 22:45:09 -07:00
.dockerignore now supports remote error reporting to sentry, if desired 2020-09-30 21:59:20 -07:00
.drone.yml don't try to tag the image, just build it 2020-10-01 00:48:30 -07:00
.gitignore now supports remote error reporting to sentry, if desired 2020-09-30 21:59:20 -07:00
Dockerfile should work now 2020-09-30 23:04:47 -07:00
LICENSE initial 2020-09-29 23:35:07 -07:00
Makefile now supports remote error reporting to sentry, if desired 2020-09-30 21:59:20 -07:00
README.md update readme 2020-09-30 05:09:52 -07:00
go.mod go mod tidy 2020-10-02 22:42:12 -07:00
go.sum go mod tidy 2020-10-02 22:42:12 -07:00

README.md

gohttpserver

Build Status

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
  • No global state

Design Decisions

  • TLS is terminated somewhere else, like on a sidecar or reverse proxy.
  • logging: rs/zerolog
  • configuration: spf13/viper
  • mux/router: gorilla/mux
    • thinking about switching to go-chi/chi which supports contexts and HandlerFunc-wrapping middleware
  • templating: TBD (suggestions welcome)
  • database: TBD (thinking about go-gorm/gorm)

TODO

  • Database Boilerplate
  • sync.Once example for precompiling templates
  • Bundling Static Assets Into Binary
  • Metrics Endpoint / Request Statistic Aggregation

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.