{"id":14983603,"url":"https://github.com/slntopp/nocloud-proto","last_synced_at":"2025-04-10T18:51:25.156Z","repository":{"id":64089010,"uuid":"569275481","full_name":"slntopp/nocloud-proto","owner":"slntopp","description":"Protobuf definitions for NoCloud","archived":false,"fork":false,"pushed_at":"2025-04-08T02:06:01.000Z","size":3711,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-08T03:22:25.816Z","etag":null,"topics":["grpc","nocloud","protobuf","protocol-buffers"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/slntopp.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-22T13:20:18.000Z","updated_at":"2024-11-27T13:35:23.000Z","dependencies_parsed_at":"2023-02-14T11:15:57.942Z","dependency_job_id":"35196546-2f17-4d61-9d3f-394b39120b81","html_url":"https://github.com/slntopp/nocloud-proto","commit_stats":{"total_commits":290,"total_committers":6,"mean_commits":"48.333333333333336","dds":0.5827586206896551,"last_synced_commit":"69c17329ac758017810221f87ebfdc709e5c24c7"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slntopp%2Fnocloud-proto","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slntopp%2Fnocloud-proto/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slntopp%2Fnocloud-proto/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slntopp%2Fnocloud-proto/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slntopp","download_url":"https://codeload.github.com/slntopp/nocloud-proto/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248274045,"owners_count":21076291,"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":["grpc","nocloud","protobuf","protocol-buffers"],"created_at":"2024-09-24T14:07:34.760Z","updated_at":"2025-04-10T18:51:25.134Z","avatar_url":"https://github.com/slntopp.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NoCloud API Proto\n\nThis repo containes protobuf files and Go generated code for the NoCloud APIs.\n\n## Install\n\n### Go\n\nAt your project(where go.mod is):\n\n```shell\ngo get github.com/slntopp/nocloud-proto@latest\n```\n\n## How to use\n\n### Generating\n\n1. Clone [this repo](https://github.com/slntopp/nocloud-proto)\n2. Navigate to cloned repo directory\n\n#### Docker\n\nJust run:\n\n```shell\ndocker run -it \\\n  -v $(pwd):/go/src/github.com/slntopp/nocloud-proto \\\n  ghcr.io/slntopp/nocloud/buf:latest\n```\n\n#### Buf\n\nSet up [`buf`](buf.build), follow Dockerfile for additional dependencies.\n\nRun `buf generate`\n\n## How to generate code for you language\n\nCheck according module for buf, add it to `buf.gen.yaml`, run `buf generate`.\n\nIf you're generating using Docker, you'd have to build image first.\n\n### JavaScript/Typescript\n\n`buf.gen.ts.yaml` as well as generated code can be found in this repo.\nTo regenerate code, you would need to have dependencies listed in `dependencies.json` installed, as well as `protoc-gen-js`, which can either be installed using `brew install protobuf@3` or [downloaded as binary from Releases here](https://github.com/protocolbuffers/protobuf-javascript).\n\nOnce you're all set up, run:\n\n```shell\nbuf generate --template buf.gen.ts.yaml\n```\n\n### How to Use\n\nSee [`examples/ts`](examples/ts) for Example in TypeScript.\n\n### PHP\n\n`buf.gen.php.yaml` as well as generated code can be found in this repo.\nIn order to regenerate code, you would need to have `grpc_php_plugin`.\n\n#### PHP gRPC\n\nFollow the [offical manual](https://cloud.google.com/php/grpc) from Google to install all the necessary tools\n\n#### grpc_php_plugin\n\nYou need the `grpc_php_plugin` to generate the PHP client stub classes. This plugin works with the main protoc binary to generate classes that you can import into your project.\n\nYou can build `grpc_php_plugin` with cmake (mind that you have to replace `RELEASE_TAG_HERE`):\n\n```shell\ngit clone -b RELEASE_TAG_HERE https://github.com/grpc/grpc\ncd grpc\ngit submodule update --init\nmkdir -p cmake/build\ncd cmake/build\ncmake ../..\nmake protoc grpc_php_plugin\n```\n\nPut `grpc_php_plugin` to `/usr/local/bin` or another directory\n\n\u003e It is necessary to change the `path` option in `buf.gen.php.yaml` if `grpc_php_plugin` location differs from `/usr/local/bin`\n\n[Source](https://grpc.github.io/grpc/php/md_src_php__r_e_a_d_m_e.html)\n\n### Dart/Flutter\n\n`buf.gen.ts.yaml` can be found in this repo.\nIn order to regenerate code, you would need to have `protoc_gen_dart` which can be obtained with `dart pub`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslntopp%2Fnocloud-proto","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslntopp%2Fnocloud-proto","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslntopp%2Fnocloud-proto/lists"}