usersrv

README

usersrv

usersrv is a production ready project template for microservices using gRPC - generated by microgen

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• Go 1.14
• Protocol Buffer v1.4.2

Install Protocol Buffer

make install_protobuf

Installing

Clone the code.

git clone https://github.com/pthethanh/usersrv

Gen gRPC, gRPC Gateway, Swagger and verify the code.

make all

Start the service.

go run main.go

Verify the APIs

curl http://localhost:8000/internal/readiness
curl http://localhost:8000/internal/liveness
curl http://localhost:8000/internal/metrics

Running the tests

Run the test by simply execute: make

Coding style

The code convention should follow effective-go

All developers are required to run make before pushing the code to remote git.

Deployment

Build Docker Image

make docker_build

Run With Docker Image

make docker

Run With Docker Compose

make compose

Deploy to Heroku

make heroku

Built With

• micro- Microservices tool kit.
• microgen - Production ready project template for microservices.

Contributing

TBU

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Thanh Pham - Initial work - Thanh Pham Github

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

TBU