drsybren/Flamenco
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity
376 Commits 1 Branch 0 Tags 45 MiB
JavaScript 58.4%
Go 30.1%
Vue 3.9%
Python 3.8%
HTML 1.9%
Other 1.8%
0f2477370f
Go to file
Sybren A. Stüvel 0f2477370f Remove SocketIO PoC 
Remove SocketIO proof of concept, as its code has been integrated into
Flamenco Manager.
2022-04-04 16:27:15 +02:00
.vscode Add VSCode launch configuration 2022-03-25 16:48:29 +01:00
addon OAPI: use GET instead of OPTIONS to get file info from Shaman 2022-04-01 15:52:17 +02:00
cmd Remove SocketIO PoC 2022-04-04 16:27:15 +02:00
internal OAPI: Add generated JavaScript API client 2022-04-01 16:40:54 +02:00
pkg OAPI: use GET instead of OPTIONS to get file info from Shaman 2022-04-01 15:52:17 +02:00
web JS: failed attempt at connecting to a dynamic endpoint URL 2022-04-01 16:54:47 +02:00
.gitignore Remove SocketIO PoC 2022-04-04 16:27:15 +02:00
.gitlab-ci.yml Configure SAST in .gitlab-ci.yml, creating this file if it does not already exist 2022-01-03 18:50:58 +00:00
CONFIG_DESIGN.md Partial design doc for configuration handling 2022-02-21 19:47:52 +01:00
debug-job-echo.sh Debugging: add simple render job script 2022-02-21 19:58:29 +01:00
debug-job-render.sh Implement frames-to-video command 2022-03-17 16:18:10 +01:00
FEATURES.md Manager: More work on Shaman support 2022-03-25 14:10:26 +01:00
go.mod Cleanup: run go mod tidy 2022-03-08 15:02:05 +01:00
go.sum Work in progress on using UPnP/SSDP to make the Worker find its Manager 2022-03-04 17:44:04 +01:00
LICENSE License: license all code under "GPL-3.0-or-later" 2022-03-07 15:26:46 +01:00
Makefile Remove SocketIO PoC 2022-04-04 16:27:15 +02:00
README.md README: just some small updates to the 'building' section 2022-03-15 12:06:38 +01:00

README.md

Flamenco 3

This repository contains the sources for Flamenco 3. The Manager, Worker, and Blender add-on sources are all combined in this one repository.

Building

  1. Install Go 1.18 or newer, Java (just a JRE is enough), and Node 16 (see below)
  2. Set the environment variable GOPATH to where you want Go to put its packages. Defaults to $HOME/go if not set. Run go env GOPATH if you're not sure.
  3. Ensure $GOPATH/bin is included in your $PATH environment variable.
  4. Magically build the web frontend (still under development, no concrete steps documentable quite yet)
  5. Run make with-deps to install build-time dependencies and build the application. Subsequent builds can just run make without arguments.

You should now have two executables: flamenco-manager and flamenco-worker.

Node / Web UI

The web UI is built with Vue, Bootstrap, and Socket.IO for communication with the backend.

NodeJS is used to collect all of those and build the frontend files. It's recommended to install Node v16 via Snap:

sudo snap install node --classic --channel=16

This also gives you the Yarn package manager, which can be used to install web dependencies and build the frontend files.

Swagger UI

Flamenco Manager has a SwaggerUI interface at http://localhost:8080/api/swagger-ui/

Database

Flamenco Manager and Worker use SQLite as database, and Gorm as object-relational mapper.

Since SQLite has limited support for altering table schemas, migration requires copying old data to a temporary table with the new schema, then swap out the tables. Because of this, avoid NOT NULL columns, as they will be problematic in this process.

License

Flamenco is licensed under the GPLv3+ license.