Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/1ambda/go-ref
Production-ready Reference Project for Golang
https://github.com/1ambda/go-ref
etcd golang grpc reference rest websocket
Last synced: about 2 months ago
JSON representation
Production-ready Reference Project for Golang
- Host: GitHub
- URL: https://github.com/1ambda/go-ref
- Owner: 1ambda
- Created: 2017-11-17T16:24:33.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T23:27:17.000Z (about 2 years ago)
- Last Synced: 2024-06-21T20:03:42.001Z (7 months ago)
- Topics: etcd, golang, grpc, reference, rest, websocket
- Language: Go
- Homepage:
- Size: 25.1 MB
- Stars: 10
- Watchers: 6
- Forks: 3
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/1ambda/go-ref)
[](http://godoc.org/github.com/1ambda/go-ref)
[](https://github.com/1ambda/go-ref/releases/latest)
# Golang Reference Project
## Component
- [service-front](https://github.com/1ambda/go-ref/tree/master/service-front): webapp
* generate rest, websocket models from [swagger spec](https://github.com/1ambda/go-ref/tree/master/schema/swagger) using [swagger-codegen](https://github.com/swagger-api/swagger-codegen)
- written in Angular 5+
- [service-gateway](https://github.com/1ambda/go-ref/tree/master/service-gateway): serving Websocket and REST endpoints
* generate rest, websocket model + server stub using [go-swagger](https://github.com/go-swagger/go-swagger)
* while working as a gRPC client
* provides scalable realtime metric servers using etcd
- [service-location](https://github.com/1ambda/go-ref/tree/master/service-backend): serving gRPC endpoints
* provides location service sharding (e.g location server 1 handles requests from US, ..)
```
+---------------+ WS (50001) +-----------------+ +------------------+
| | REST (50002) | | gRPC (50003) | |
| service-front |<--------------->| service-gateway |<---------------->| service-location |
| | (swagger-gen) | | (protobuf) | |
+---------------+ +-----------------+ +------------------+
(webapp) (server) (server)
< storage >
+--------------+ +-------------+
| | | |
| etcd cluster | | mysql |
| | | |
+--------------+ +-------------+
(distributed kv) (transactional)
```
## Requirements
| name | version | description |
|---|---|---|
| [go](https://github.com/golang/go) | 1.10+ | use [gvm](https://github.com/moovweb/gvm) |
| [dep](https://github.com/golang/dep) | | `go get -u github.com/golang/dep/cmd/dep` |
| [protobuf](https://github.com/google/protobuf) | 3.5.0+ | `brew install protobuf` |
| [nodejs](https://nodejs.org/) | 9.8.0+ | use [nvm](https://github.com/creationix/nvm) |
Please check [make prepare](https://github.com/1ambda/go-ref/blob/master/scripts/makefiles/install.mk#L6) command for more description.
## Quick Start
```bash
# start dockerized storages: etcd, mysql, ...
$ docker-compose up
```
```bash
# start gateway service
$ cd service-gateway
$ make prepare install
$ make run
```
```bash
# start front (webapp) service
$ cd service-front
$ npm install; npm run server:local;
# visit: https://localhost:3000
```
## Screenshot
