Quickstart
A quickstart.md is useful to users who may need to bring up the service as a dependency to something else, or someone
who needs to quickly bring up the service to
validate a recent change.
A quickstart.md should aim to capture the minimal steps to get an environment up and running along with any first time
setup that may come along with the service. This document should aim to get an environment up as quickly as possible
while leaving the more customization and tips in the development.md file.
For example, the quickstart for this repo may look like the following:
docker-compose up -d
go run main.go
Expect to see logs like the following:
Using config file: gossip.yaml
INFO[0000] starting implemented server platform-server-id=sdk__gossip-demo-svc server-name=grpc
INFO[0000] starting implemented server platform-server-id=sdk__gossip-demo-svc server-name=metrics
INFO[0000] starting implemented server platform-server-id=sdk__gossip-demo-svc server-name=health
INFO[0000] starting implemented server platform-server-id=sdk__gossip-demo-svc server-name=pprof
INFO[0000] starting servers in group... platform-server-id=sdk__gossip-demo-svc
INFO[0000] preparing server local-addr="[::]:8380" platform-server-id=sdk__gossip-demo-svc server-name=metrics
INFO[0000] preparing server local-addr="[::]:83" platform-server-id=sdk__gossip-demo-svc server-name=grpc
INFO[0000] preparing server local-addr="[::]:8381" platform-server-id=sdk__gossip-demo-svc server-name=pprof
INFO[0000] preparing server local-addr="[::]:8382" platform-server-id=sdk__gossip-demo-svc server-name=health
