This is my boilerplate for a Go http server project. Feedback and suggestions are encouraged!
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jeffrey Paul 4e663d848a Merge branch 'static' of sneak/gohttpserver into master 4 月之前
cmd/httpd switch to gofumpt 4 月之前
httpserver simplify static file handler 4 月之前
.dockerignore now supports remote error reporting to sentry, if desired 5 月之前
.drone.yml don't try to tag the image, just build it 5 月之前
.gitignore now uses rice 4 月之前
Dockerfile install rice during docker build 4 月之前
LICENSE initial 5 月之前
Makefile install rice during docker build 4 月之前
README.md update README 4 月之前
go.mod now uses rice 4 月之前
go.sum now uses rice 4 月之前

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
  • Prometheus metrics endpoint
  • No global state of our own
    • some deps have some, such as the metrics collector and Sentry

Design Decisions

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.