gohttpserver/README.md

71 lines
2.0 KiB
Markdown
Raw Normal View History

2020-09-30 06:35:07 +00:00
# gohttpserver
[![Build Status](https://drone.datavi.be/api/badges/sneak/gohttpserver/status.svg)](https://drone.datavi.be/sneak/gohttpserver)
2020-09-30 08:39:19 +00:00
This is my boilerplate for a go HTTP server, designed to be a
starting point template for new projects.
2020-09-30 06:35:07 +00:00
2020-09-30 08:39:19 +00:00
Many ideas are taken from Mat Ryer's talk titled "How I Write HTTP Web Services
after Eight Years" at GopherCon 2019, seen here:
2020-09-30 06:35:07 +00:00
https://www.youtube.com/watch?v=rWBSMsLG8po
2020-09-30 08:39:19 +00:00
# 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](mailto:sneak@sneak.berlin)
# Features
* Basic logging middleware
* Stub Authentication middleware
* Helper functions for encoding/decoding json
* Healthcheck route
* No global state
2020-09-30 12:07:31 +00:00
# Design Decisions
* TLS is terminated somewhere else, like on a sidecar or reverse proxy.
* logging: [rs/zerolog](https://github.com/rs/zerolog)
* configuration: [spf13/viper](https://github.com/spf13/viper)
* mux/router: [gorilla/mux](https://github.com/gorilla/mux)
* templating: TBD (suggestions welcome)
* database: TBD (thinking about [go-gorm/gorm](https://github.com/go-gorm/gorm))
2020-09-30 06:35:07 +00:00
# TODO
* Database Boilerplate
2020-09-30 08:39:19 +00:00
* sync.Once example for precompiling templates
2020-09-30 06:35:07 +00:00
* Bundling Static Assets Into Binary
2020-09-30 08:39:19 +00:00
* Metrics Endpoint / Request Statistic Aggregation
2020-09-30 06:35:07 +00:00
# Author
2020-09-30 08:39:19 +00:00
* [sneak@sneak.berlin](mailto:sneak@sneak.berlin)
* https://sneak.berlin
* [@sneak@sneak.berlin](https://s.sneak.berlin/@sneak)
2020-09-30 06:35:07 +00:00
# License
2020-09-30 08:39:19 +00:00
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.
```