Flamenco/README.md

# Flamenco PoC

This repository contains a proof of concept of a next-generation Flamenco implementation.

## Building

1. Install [Go 1.18 or newer](https://go.dev/) 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-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.
Add README.md 2022-01-10 13:14:38 +00:00			`# Flamenco PoC`

			`This repository contains a proof of concept of a next-generation Flamenco implementation.`

			`## Building`

Bump Go version to 1.18 for generics support 2022-02-18 10:41:31 +00:00			`1. Install [Go 1.18 or newer](https://go.dev/) and Node 16 (see below)`
Update README with `go env GOPATH` 2022-01-10 13:46:12 +00:00			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.
SocketIO based chat client as PoC for backend/frontend communication The chat client itself is just a throwaway project. The SocketIO system will be used to send realtime updates about jobs, tasks, and workers to the web frontend. 2022-02-11 13:47:26 +00:00			`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.
Add README.md 2022-01-10 13:14:38 +00:00
			You should now have two executables: `flamenco-manager-poc` and `flamenco-worker-poc`.

SocketIO based chat client as PoC for backend/frontend communication The chat client itself is just a throwaway project. The SocketIO system will be used to send realtime updates about jobs, tasks, and workers to the web frontend. 2022-02-11 13:47:26 +00:00
			`## 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.`

Add README.md 2022-01-10 13:14:38 +00:00			`## Swagger UI`

			`Flamenco Manager has a SwaggerUI interface at http://localhost:8080/api/swagger-ui/`
Start of database interface Contains a dummy migration because the migrate package will error out if it cannot find any migration files. 2022-01-11 14:58:02 +00:00
Manager: switch from PostgreSQL to SQLite This includes a modified copy of the Gorm SQLite backend, adjusted to use https://modernc.org/sqlite instead. 2022-03-01 17:50:31 +00:00			`## Database`
Start of database interface Contains a dummy migration because the migrate package will error out if it cannot find any migration files. 2022-01-11 14:58:02 +00:00
Manager: Fix DB migration error of not-null columns Where the PostgreSQL DB migration code could handle `NOT NULL` columns just fine, SQLite has less table-altering functionality. As a result, migrations have to copy entire database tables, which doesn't play well with not-nullable columns. 2022-03-03 11:06:22 +00:00			`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.`
README: document licenses better 2022-03-03 11:10:24 +00:00
			`## License`

			`Flamenco is licensed under the GPLv3+ license.`