README: no longer a "proof of concept"

This commit is contained in:
Sybren A. Stüvel 2022-03-04 13:24:57 +01:00
parent 183bb23d2a
commit 1e784452f3

View File

@ -1,6 +1,8 @@
# Flamenco PoC # 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.
This repository contains a proof of concept of a next-generation Flamenco implementation.
## Building ## Building
@ -25,10 +27,12 @@ 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. This also gives you the Yarn package manager, which can be used to install web dependencies and build the frontend files.
## Swagger UI ## Swagger UI
Flamenco Manager has a SwaggerUI interface at http://localhost:8080/api/swagger-ui/ Flamenco Manager has a SwaggerUI interface at http://localhost:8080/api/swagger-ui/
## Database ## Database
Flamenco Manager and Worker use SQLite as database, and Gorm as Flamenco Manager and Worker use SQLite as database, and Gorm as
@ -39,6 +43,7 @@ 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 tables. Because of this, avoid `NOT NULL` columns, as they will be problematic
in this process. in this process.
## License ## License
Flamenco is licensed under the GPLv3+ license. Flamenco is licensed under the GPLv3+ license.