skottie/

directory
v0.0.0-...-0390e60 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 18, 2024 License: BSD-3-Clause

README

skottie

A web application for viewing lottie files as rendered by Skia, and going forward, other renderers. It uses CanvasKit to display these.

Local development

Install buildbot dependencies

Follow instructions to enable gcloud

Ask a Skia Maintainer to give view access to GCS buckets artifacts.skia-public.appspot.com (for downloading build images) and skottie-renderer (for runtime downloading/uploading of lottie assets).

Run the local server.

make run-local-instance

By default, you can connect to the web server in your browesr by going to localhost:8000.

If you want see any module changes you make without restarting the whole server, open another terminal and run:

make watch-modules

When the changes finish building you can now reload the page to see them.

Which version of CanvasKit is being used?

When running tests (bazel test ...) or a local instance (make run-local-instance), the rules are set up to get the latest built version of CanvasKit by looking at gcr.io/skia-public/skia-wasm-release:prod. See ./wasm_libs/BUILD.bazel for more.

To run skottie locally with a custom build of CanvasKit, copy the files to //skottie/wasm_libs/local_build and run:

make run-with-custom

Do not check in those files you copied.

Deployment

Skottie is made up of the web application, contained within this folder, and CanvasKit which comes from the Skia repository. The //skottie/skottie_container-base build target creates a "base" Docker image which contains everything except CanvasKit. This is uploaded to gcr.io/skia-public/skottie-base. The "final" build is in the Skia repository. That build pulls down the base image, layers CanvasKit on top, and uploads the final Docker image to gcr.io/skia-public/skottie-final.

Both the base and final builds are done in Louhi, and there should be no need to manually build or upload either Docker image. If this is deemed necessary then a new base image may be built and uploaded by:

$ make release

Directories

Path Synopsis
go
ts
Program to generate TypeScript definition files for Golang structs that are serialized to JSON for the web UI.
Program to generate TypeScript definition files for Golang structs that are serialized to JSON for the web UI.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL