Commit Graph

26 Commits

Author SHA1 Message Date
e6b662b8cd README.md: remove most info from the README and direct to the website
The website (which is available in the sources as well) contains all the
information from the README already. Having only one source of information
is good for maintainability.
2022-08-01 16:56:40 +02:00
Nate Rupsis
2c5b41555c README.md: compatibility with Phabricator
Fix issues where Phabricator would render the README.md incorrectly.

Reviewed by: sybren

Differential Revision: https://developer.blender.org/D15367
2022-07-05 17:14:09 +02:00
7d64d1bca4 Move SwaggerUI to /api/v3/swagger-ui
Include the `v3` path component in the Swagger UI URL.
2022-07-04 12:21:18 +02:00
7b028df8ac Manager: serve static files of the webapp at /app/
Vue Router generates URLs for which there are no static files on the
filesystem (like `/jobs/{job ID}`). To make this work, the webapp's
`index.html` has to be served for such requests. The client-side JavaScript
then figures out how things fit together, and can even render a nice 404
page if necessary.

This shouldn't happen for non-webapp URLs, though. Because of this, the
entire webapp (including the "serve `index.html` if file not found logic)
is moved to a `/app/` base URL.

`make flamenco-manager` now also builds the webapp and embeds the static
files into the binary.

`make flamenco-manager_race` does NOT rebuild the static web files, to
help speed up of debug cycles. Run `make webapp-static` to rebuild the
webapp itself, if necessary, or run a separate web development server with
`yarn --cwd web/app run dev --host`.
2022-06-27 14:53:42 +02:00
d8be9d95e8 README: document task status meanings 2022-06-17 11:37:28 +02:00
79c632bc9f README: expand documentation of code generation 2022-05-20 10:49:37 +02:00
f7e028bcdc Document guidelines on how to commit OpenAPI changes 2022-05-19 16:01:53 +02:00
744fabea78 OAPI: rename pkg/api/flamenco-manager.yaml to flamenco-openapi.yaml
Rename `pkg/api/flamenco-manager.yaml` to `flamenco-openapi.yaml`, to
distinguish the OpenAPI definition file from the Flamenco Manager
configuration file of the same name (but in a different directory).

No functional changes.
2022-05-19 15:22:37 +02:00
618bc8c72f Add documentation for Shaman on Windows
List the steps to take, to allow creating symlinks by regular users.
2022-05-19 10:06:55 +02:00
1535d7531b Document the use of SocketIO in README.md 2022-04-15 13:51:32 +02:00
b12af4c60e Update README.md to reflect the new way to set up the web dev environment 2022-04-12 12:41:24 +02:00
2fb3b4d615 Update README for clarity & to document more about the web frontend 2022-04-05 17:28:19 +02:00
8382fde977 README: just some small updates to the 'building' section 2022-03-15 12:06:38 +01:00
1e784452f3 README: no longer a "proof of concept" 2022-03-04 13:24:57 +01:00
9b9c6bffff Replace self-hacked SQLite Gorm driver with 3rd party one
The new Gorm driver is made by the creators of the pure-Go SQLite library
we were already using.
2022-03-03 13:48:14 +01:00
a563f36b98 README: document licenses better 2022-03-03 12:10:24 +01:00
9643bf768e 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 12:10:13 +01:00
e70a44a146 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 18:50:31 +01:00
Sybren A. Stüvel
df5e990693 Update install instructions for Windows 2022-02-21 15:24:39 +01:00
8424e690ee Bump Go version to 1.18 for generics support 2022-02-18 11:41:31 +01:00
96023932da 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 14:47:26 +01:00
edda8f21cf Make tests work on PostgreSQL 2022-01-25 18:12:01 +01:00
e4be846de8 Add make with-deps target to install dependencies and build the apps 2022-01-24 14:27:25 +01:00
0c9c99806b 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 18:07:34 +01:00
Sybren A. Stüvel
87826b5179 Update README with go env GOPATH 2022-01-10 17:45:13 +01:00
Sybren A. Stüvel
9b4aa11c82 Add README.md 2022-01-10 17:45:13 +01:00