cd2fe8170e
Instead of returning an error "error doing X", just return "doing X". The fact that it's returned as an error object says enough about that it's an error. This also makes it easier to chain error messages, without seeing the word "error" in every part of the chain.
Flamenco PoC
This repository contains a proof of concept of a next-generation Flamenco implementation.
Building
- Install Go 1.18 or newer and Node 16 (see below)
- Set the environment variable
GOPATHto where you want Go to put its packages. Defaults to$HOME/goif not set. Rungo env GOPATHif you're not sure. - Ensure
$GOPATH/binis included in your$PATHenvironment variable. - Magically build the web frontend (still under development, no concrete steps documentable quite yet)
- Run
make with-depsto install build-time dependencies and build the application. Subsequent builds can just runmakewithout arguments.
You should now have two executables: flamenco-manager-poc and flamenco-worker-poc.
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.