Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kbiakov/anakin
Codegeneration tool for isomorphic server and mobile Go apps with gRPC & Protobuf. Share code between your backend, Android & iOS app! :sun_with_face:
https://github.com/kbiakov/anakin
android codegeneration go golang grpc ios protobuf
Last synced: 3 months ago
JSON representation
Codegeneration tool for isomorphic server and mobile Go apps with gRPC & Protobuf. Share code between your backend, Android & iOS app! :sun_with_face:
- Host: GitHub
- URL: https://github.com/kbiakov/anakin
- Owner: kbiakov
- License: gpl-3.0
- Created: 2016-10-28T11:13:02.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-24T21:22:27.000Z (about 7 years ago)
- Last Synced: 2024-10-30T16:29:07.519Z (3 months ago)
- Topics: android, codegeneration, go, golang, grpc, ios, protobuf
- Language: Go
- Homepage:
- Size: 37.1 KB
- Stars: 17
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Anakin [](https://godoc.org/github.com/Softwee/Anakin) [](https://goreportcard.com/report/github.com/Softwee/Anakin) [](https://codeclimate.com/github/kbiakov/Anakin/maintainability) [](https://travis-ci.org/Softwee/Anakin) [](https://android-arsenal.com/details/1/4625)
Codegeneration tool for isomorphic server and mobile Go apps with gRPC & Protobuf. Share code between your backend, Android & iOS app!
## Description
Anakin takes care about some routine tasks and helps to create shared code between client (mobile apps) & server app written in Go and backed by gRPC & Protobuf. So, how it works?
At the first stage, it just generates from your ```*.proto``` (with defined service, RPC-calls & allowed messages) main gRPC-file ```*.pb.go``` which may be used by any Go app. It uses ```protoc``` utility.
Next Anakin parses ```*.proto```-file to extract RPC-methods and messages, takes templates for client and server & generates similar Go code. After that it builds binaries for Android (```*.aar```) and iOS (```*.framework```) using ```gomobile```.
Mobile binaries build stage may fail by different reasons and you may want to go back again later when environment will be ready. Also you can ignore build stage if you want to make some changes in generated code. Anyway Anakin has another ```anakin-build``` script inside for this purpose, which automatically copied for generated ```$YOUR_OUTPUT/client``` directory with other source files when you run original ```anakin``` script.
## Required
1. Go 1.5 and higher.
2. Xcode Command Line Tools (Mac OS X only, will be installed if needed).
3. Android SDK (if Android build is needed).
## Usage
```
anakin -P myrpc.proto [-O output_dir] [-h localhost] [-p 50051] [-android] [-ios]
```
Flags:
```-P | --proto ``` *(required)* path to ```*.proto```-file
```-O | --output ``` *(optional)* path to output directory, default: ```/gen```
```-h | --host ``` *(optional)* server host, default: localhost
```-p | --port ``` *(optional)* server port, default: 50051
```-android``` *(optional)* is Android build needed, default: false
```-ios``` *(optional)* is iOS build needed, default: false
```
anakin-build [--android 1] [--ios 1]
```
Flags:
```--android 1``` *(optional)* is Android build needed, default: 1 (true)
```--ios 1``` *(optional)* is iOS build needed, default: 1 (true)
## Author
### [Kirill Biakov](https://github.com/kbiakov)
## License
```
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
```