{"id":14975895,"url":"https://github.com/yindia/grpc-boilerplate","last_synced_at":"2025-07-04T08:34:21.350Z","repository":{"id":41802412,"uuid":"160342859","full_name":"yindia/grpc-boilerplate","owner":"yindia","description":"Typescript GRPC Boilerplate with CI/CD setup for kuberneates and envoy","archived":false,"fork":false,"pushed_at":"2022-12-08T07:25:27.000Z","size":833,"stargazers_count":5,"open_issues_count":17,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T06:31:47.300Z","etag":null,"topics":["circleci","cloudbuild","docker","dockercompose","envoy","kubernetes","nodejs","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yindia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-04T10:52:33.000Z","updated_at":"2023-08-22T17:25:01.000Z","dependencies_parsed_at":"2023-01-25T08:45:46.862Z","dependency_job_id":null,"html_url":"https://github.com/yindia/grpc-boilerplate","commit_stats":null,"previous_names":["yindia/grpc-boilerplate"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yindia%2Fgrpc-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yindia%2Fgrpc-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yindia%2Fgrpc-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yindia%2Fgrpc-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yindia","download_url":"https://codeload.github.com/yindia/grpc-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238508915,"owners_count":19484228,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["circleci","cloudbuild","docker","dockercompose","envoy","kubernetes","nodejs","typescript"],"created_at":"2024-09-24T13:52:49.636Z","updated_at":"2025-02-12T16:32:24.243Z","avatar_url":"https://github.com/yindia.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Microservice Mesh\n\n\n## Component\n  - twitter Backend\n  - comman NPM package for binddings all comman library like grpc,mysql,logging\n  - Exotel client for testing backend \n  - Dockerfile \u0026 K8s (Both work independently on platform google/aws/datacenter) \n  - bitbucket-pipelines.yml (yml file for bitbucet pipeline for CI-CD)\n  - .Circle CI (yml config for service mess deplyment of microservices)\n  - cloudbuild (build file for REST deployment of Google builder)\n  - envoy config (service discovvery)\n  - sonar.properties (sonar configration for sonar scan)\n\n## prerequest\n - nodejs (8+)\n - npm \n - docker\n - kubectl \n \n# twitter \n\n## Get started \n```sh\n$ sudo make\n```\n\n### How to test functions :\nTest getUser Function\n```sh\n$ docker run -it --rm  twitter-client node client get 1 \n```\nTest createUser Function\n```sh\n$ docker run -it --rm  twitter-client node client insert Yuvraj evalsocket hello@123 \n```\nTest followUser Function\n```sh\n$ docker run -it --rm  twitter-client node client follow 1 2 \n```\nTest homeTimeline Function\n```sh\n$ docker run -it --rm  twitter-client node client home 1  \n```\nTest userTimeline Function\n```sh\n$ docker run -it --rm  twitter-client node client timeline 1  \n```\n\nTest createTweet Function\n```sh\n$ docker run -it --rm twitter-client node client tweet 1  hello\n```\n\nConfigration  :  Change mysql configration (local)\n\nHow to start without docker :\n```sh\n$ #Run backend \n$ npm install (Install npm dependencies)\n$ npm run build (Build typescript)\n$ npm run serve (start grpc server port 8080)\n$ npm run dev (start grpc server on dev mode port 8080)\n$ #Run client \n$ cd client\n$ export grpc_backend=35.243.198.252:80\n$ npm install\n$ node cleint get 1\n\n```\nHow to start with docker :\n```sh\n$ # Run Docker container\n$ docker build -t twitter-backend .\n$ docker run -d --name twitter-backend twitter-backend\n$ # Run envoy proxy \n$ cd envoy\n$ docker build -t front-envoy .\n$ docker run -d --name front-envoy --link  twitter-backend:twitter-backend -p 8080:8080 front-envoy\n$ # Run exotel client \n$ cd client\n$ docker build -t twitter-client .\n$ docker run -d --name twitter-client  --env grpc_backend=35.243.198.252:80(APP ENGINE) twitter-client (If you are running backend locally the use 127.0.0.1:8080)\n$ docker run -d --name twitter-client  --env grpc_backend=35.221.233.116:80(Kuberneates envoy proxy) twitter-client (If you are running backend locally the use 127.0.0.1:8080)\n```\n\nHow to start with kubctl : (optional)\n```sh\n$ # Run Docker container\n$ docker build -t twitter-backend .\n$ docker run -it --name twitter-backend -p 50051:8080 twitter-backend\n$ Replace Variable name manully in k8s/k8s/cloudbuild/deployment.yml\n$ kubectl  apply -f k8s/k8s/cloudbuild/deployment.yml\n```\n\n\nTo-DO :\n   - Logger is created in comman lib (connected to google stackdriver with winston) just need to write log in the backend  (error handling is not done)\n   - Test cases are their just for testing demo( someone has to write test cases for all function)\n   - Improve proto file by using proto third party like(struct and datetime)\n   - For actual service mesh we have to divide backend into two microservice (tweet \u0026 user) and decide the envoy config \n   - I think work needed on mysql queries (didn't test for billion entries) but for now i rely on infra \n  \n  ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyindia%2Fgrpc-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyindia%2Fgrpc-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyindia%2Fgrpc-boilerplate/lists"}