sneak/gohttpserver
1
0
Fork 0
Code Issues 5 Pull Requests 1 Releases Wiki Activity

update README #12

Manually merged
sneak merged 1 commits from add-fumpt into master 2020-10-10 16:08:41 +00:00
Conversation 0 Commits 1 Files Changed 1 +12 -4
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -31,21 +31,29 @@ Alternately, even just feedback is great:
# Design Decisions # Design Decisions
* TLS is terminated somewhere else, like on a sidecar or reverse proxy. * 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](https://github.com/rs/zerolog) * logging: [rs/zerolog](https://github.com/rs/zerolog)
* configuration: [spf13/viper](https://github.com/spf13/viper) * configuration: [spf13/viper](https://github.com/spf13/viper)
* used as a wrapper around env vars * used as a wrapper around env vars, because of typed getters
* router is Chi: [go-chi/chi](https://github.com/go-chi/chi) * router is Chi: [go-chi/chi](https://github.com/go-chi/chi)
* Prometheus-style metrics via [slok/go-http-metrics](https://github.com/slok/go-http-metrics) * Prometheus-style metrics via [slok/go-http-metrics](https://github.com/slok/go-http-metrics)
* code formatted with [mvdan.cc/gofumpt](https://mvdan.cc/gofumpt)
* code style checked with [golangci/golangci-lint](https://github.com/golangci/golangci-lint)
# Pending Design Decisions
* database: TBD (thinking about [go-gorm/gorm](https://github.com/go-gorm/gorm)) * database: TBD (thinking about [go-gorm/gorm](https://github.com/go-gorm/gorm))
* templating: TBD (suggestions welcome) * templating: TBD (suggestions welcome)
# TODO # TODO
* Basic HTML Templates
* Database Boilerplate * Database Boilerplate
* Sessions Middleware * Sessions Middleware
* sync.Once example for precompiling templates * sync.Once example for re-compiling templates
* Bundling Static Assets Into Binary * Bundling static assets into binary
# Known Bugs (more TODO) # Known Bugs (more TODO)