blender/flamenco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
flamenco/web/flamenco-io-site/content/development/generating-code/_index.md
Sybren A. Stüvel 3c7c79206e More work on the new flamenco.io site 
This is basically the contents of the `README.md` file, spread over
multiple documentation pages.
2022-07-05 14:46:38 +02:00

967 B
Raw Blame History

title weight
Generating Code 20

Some code (Go, Python, JavaScript) is generated from the OpenAPI specs in pkg/api/flamenco-openapi.yaml. There are also Go files generated to create mock implementations of interfaces for unit testing purposes.

Generated code is committed to Git, so that after a checkout you shouldn't need to re-run the generator to build Flamenco.

The JavaScript & Python generator is made in Java, so it requires a JRE/JDK to be installed. On Ubuntu Linux, sudo apt install default-jre-headless should be enough.

The following files & directories are generated. Generated directories are completely erased before regeneration, so do not add any files there manually.

  • addon/flamenco/manager/: Python API for the Blender add-on.
  • pkg/api/*.gen.go: Go API shared by Manager and Worker.
  • internal/**/mocks/*.gen.go: Generated mocks for Go unit tests.
  • web/app/src/manager-api/: JavaScript API for the web front-end.