https://github.com/sreejeet/garagesale
A RESTful Go web service
https://github.com/sreejeet/garagesale
docker docker-compose golang postgresql restful-api sql
Last synced: 3 months ago
JSON representation
A RESTful Go web service
- Host: GitHub
- URL: https://github.com/sreejeet/garagesale
- Owner: sreejeet
- Created: 2020-06-05T19:35:21.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-03T16:25:16.000Z (over 5 years ago)
- Last Synced: 2024-11-15T00:59:34.155Z (over 1 year ago)
- Topics: docker, docker-compose, golang, postgresql, restful-api, sql
- Language: Go
- Homepage:
- Size: 219 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/sreejeet/garagesale)
# Production ready RESTful API service.
Garagesale is a production ready RESTful API service running on docker. It is build without any framework to keep the service as light as possible.
This is a product of my work while training for Go based web services.
The open source [training material](https://github.com/ardanlabs/service-training) is provided by [Ardan Labs](http://www.ardanlabs.com/).
## Tech stack
1. Go's [net/http](https://golang.org/pkg/net/http/)
2. [Docker](https://www.docker.com)
3. [PostgreSQL](https://www.postgresql.org/)
4. [JSON Web Tokens](https://jwt.io/)
5. [Zipkin](https://zipkin.io)
6. [OpenCensus](https://opencensus.io)
## Run on local system
1. Run `docker-compose up`
2. Use `cmd/sales-admin/main.go` to migrate schema / seed database / add user / generate private key
3. User `cmd/sales-api/main.go` to start the sales API which listens at localhost:8000 by default
## A consolidated list of resources I found useful.
(Please raise an issue if you find broken links)
1. [The complete guide to Go net/http timeouts](https://blog.cloudflare.com/the-complete-guide-to-golang-net-http-timeouts/)
2. [So you want to expose Go on the Internet](https://blog.cloudflare.com/exposing-go-on-the-internet/)
3. [Parsing JSON files With Golang](https://tutorialedge.net/golang/parsing-json-with-golang/)
4. [Go database/sql tutorial](http://go-database-sql.org/)
5. [Docker Compose](https://docs.docker.com/compose/compose-file)
6. [Docker logs](https://docs.docker.com/config/containers/logging/)
7. [Package Oriented Design](https://www.ardanlabs.com/blog/2017/02/package-oriented-design.html)
8. [Package conf](https://github.com/ardanlabs/service-training/blob/master/06-configuration/internal/platform/conf/README.md)
9. [Error Handling in Go](https://medium.com/@hussachai/error-handling-in-go-a-quick-opinionated-guide-9199dd7c7f76)
10. [Package initialization and program execution order](https://yourbasic.org/golang/package-init-function-main-execution-order/)
11. [How to collect, standardize, and centralize Golang logs](https://www.datadoghq.com/blog/go-logging/)
12. [Error handling and Go](https://blog.golang.org/error-handling-and-go)
13. [Structs and Interfaces](https://www.golang-book.com/books/intro/9) (This is part of a book from 2012. Outdated, but a good read nonetheless.)
14. [Understanding the context package in golang](http://p.agnihotry.com/post/understanding_the_context_package_in_golang/)
15. [Go: Context and Cancellation by Propagation](https://medium.com/a-journey-with-go/go-context-and-cancellation-by-propagation-7a808bbc889c)
16. [PostgreSQL Joins](https://www.postgresqltutorial.com/postgresql-joins/)
17. [PostgreSQL SUM Function](https://www.postgresqltutorial.com/postgresql-sum-function/)
18. [Profiling Go Programs](https://blog.golang.org/pprof)
19. [Middleware (Advanced)](https://gowebexamples.com/advanced-middleware/)
20. [Creating a Middleware in Golang for JWT based Authentication](https://hackernoon.com/creating-a-middleware-in-golang-for-jwt-based-authentication-cx3f32z8)
21. [How to instrument Go code with custom expvar metrics](https://sysdig.com/blog/golang-expvar-custom-metrics/)
22. [Go App Monitoring: expvar, Prometheus and StatsD](https://www.opsdash.com/blog/golang-app-monitoring-statsd-expvar-prometheus.html)
23. [Expose application metrics with expvar](http://blog.ralch.com/tutorial/golang-metrics-with-expvar/)
24. [Golang context.WithValue](https://stackoverflow.com/a/40380147/13512702)
25. [How to pass context in golang request to middleware](https://stackoverflow.com/a/49247940/13512702)
26. [How To Use Struct Tags in Go](https://www.digitalocean.com/community/tutorials/how-to-use-struct-tags-in-go)
27. [Tags in Golang](https://medium.com/golangspec/tags-in-golang-3e5db0b8ef3e)
28. [JSON Web Token Claims](https://auth0.com/docs/tokens/concepts/jwt-claims)
29. [Implementing JSON Web Token (JWT) to secure your app](https://blog.nextzy.me/implementing-json-web-token-jwt-to-secure-your-app-c8e1bd6f6a29)
30. [Symmetric vs Asymmetric JWTs](https://blog.usejournal.com/symmetric-vs-asymmetric-jwts-bd5d1a9567f6)
31. [Hacking JSON Web Tokens (JWTs)](https://medium.com/swlh/hacking-json-web-tokens-jwts-9122efe91e4a)
32. [Critical vulnerabilities in JSON Web Token libraries](https://auth0.com/blog/critical-vulnerabilities-in-json-web-token-libraries/)
33. [Zipkin Tutorial: Get Started Easily With Distributed Tracing](https://www.scalyr.com/blog/zipkin-tutorial-distributed-tracing/)
34. [OpenCensus Tracing](https://opencensus.io/tracing/)