Skip to content

Installation

Dependencies

Python (required for code generation)

pip install proto-schema-parser

Language-Specific Requirements

GCC or compatible C compiler:

# Ubuntu/Debian
sudo apt install gcc

# macOS
xcode-select --install

# Windows (MinGW)
# Download from https://www.mingw-w64.org/

G++ with C++14 support:

# Ubuntu/Debian
sudo apt install g++

# macOS
xcode-select --install

# Windows (MinGW)
# Included with MinGW-w64

Node.js and npm:

# Ubuntu/Debian
sudo apt install nodejs npm

# macOS
brew install node

# Windows
# Download from https://nodejs.org/

Python 3.8 or later (already required for code generation).

GraphQL schemas can be used with any GraphQL server implementation.

Quick Start

  1. Install the Python dependency: 

    pip install proto-schema-parser

  2. Clone the repository: 

    git clone https://github.com/mylonics/struct-frame.git
cd struct-frame

  3. Generate code from a proto file: 

    PYTHONPATH=src python src/main.py examples/generic_robot.proto --build_py --py_path gen/py

  4. Use the generated code in your project.

Next Steps