@@ -12,6 +12,7 @@ Deferring because out of scope is fine, but don't mention deferring than.
|
||||
|
||||
### To be sorted
|
||||
|
||||
- FEAT/UI the CLI of fluksio should be improved by using colors and styling as well as ctrl-c handling. Consider a small TUI which serves like a mini-dashboard showing current flow status and error messages
|
||||
- FEAT/UI when a dashboard has more widgets than the canvas allows for, the canvas should become scrollable (temporarily) to allow scrolling to the widgets outside the canvas and reordering them
|
||||
- BUG/UI some nodes (especially smaller ones) in the brain graph still don't have a pixel perfect centered ring and node background
|
||||
- FEAT/UI: make the "Settings" button in the dashboard panel a toggle; such that it becomes stateful and pressing again closes the settings panel
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
# Fluksio App
|
||||
|
||||
Fluksio has the goal to build a revolutionary system to tackle any sort of automation challenge.
|
||||
Fluksio is a node-based automation software that brings trust and reliability to your flow.
|
||||
It just works and looks good.
|
||||
|
||||
The core of Fluksio: a node-based, test-driven automation software built to scale. This
|
||||
repo holds the FastAPI backend, the flow engine, and the dashboard SPA. It is served on
|
||||
`app.${DOMAIN}` (SPA) and `api.${DOMAIN}` (API); the marketing site lives in the sibling
|
||||
`index` repo.
|
||||
`app.${DOMAIN}` (SPA) and `api.${DOMAIN}` (API)
|
||||
|
||||
## Layout
|
||||
|
||||
```text
|
||||
backend/ FastAPI + SQLModel + Alembic + SQLite — the `fluksio` distribution
|
||||
backend/ FastAPI + SQLModel + Alembic + SQLite
|
||||
fluksio/flow/ the flow engine (nodes, pipeline, state backends, controller)
|
||||
fluksio/cli.py `fluksio serve` / `enroll` / `worker`
|
||||
worker/ the `fluksio-worker` distribution: the agent and the node runner
|
||||
@@ -22,19 +22,23 @@ scripts/ generate-client.sh, test.sh
|
||||
|
||||
## Install without Docker
|
||||
|
||||
Get started quickly by running
|
||||
|
||||
```sh
|
||||
pip install fluksio
|
||||
fluksio serve # ~/.fluksio, SQLite, prints an admin password once
|
||||
fluksio enroll <code> --portal https://hub.fluksio.com # watch it from the portal
|
||||
fluksio serve
|
||||
```
|
||||
|
||||
Nothing else has to be running. `--data-dir` puts the installation somewhere else —
|
||||
worth it on a cluster, where `$HOME` is often a network filesystem SQLite cannot use.
|
||||
`git` is not required but is worth having: flows are files either way, and it is what
|
||||
turns each save into a commit.
|
||||
The dashboard is served by the portal, so a machine with no inbound route is reached
|
||||
without opening a port: it dials out.
|
||||
Then, head over to [fluksio.com](https://fluksio.com), sign up and add a new installation.
|
||||
Using the code provided, run
|
||||
|
||||
```sh
|
||||
fluksio enroll <code>
|
||||
```
|
||||
|
||||
and you're ready to rock.
|
||||
|
||||
Fluksio is distributed at it's heart.
|
||||
A machine that should only *run nodes* for an engine elsewhere installs less:
|
||||
|
||||
```sh
|
||||
@@ -71,18 +75,10 @@ make docs # static build into ./site
|
||||
```
|
||||
|
||||
It is served at `docs.${DOMAIN}` by the `docs` service in `docker/compose.yml`,
|
||||
and `.gitea/workflows/docs.yml` builds it with `--strict` on every push. Style
|
||||
follows the root `DESIGN-GUIDELINES.md`; the tokens are mirrored in
|
||||
`docs/stylesheets/extra.css`.
|
||||
and `.gitea/workflows/docs.yml` builds it with `--strict` on every push.
|
||||
|
||||
Repo-only material:
|
||||
|
||||
- [`ROADMAP.md`](ROADMAP.md) — strategy and feature record
|
||||
- [`NOTEPAD.md`](NOTEPAD.md) — deferred work and findings
|
||||
- [`DESIGN.md`](DESIGN.md) — points at the workspace root's `DESIGN-GUIDELINES.md`
|
||||
- `docs/architecture/` in the sibling `docs` repo — the requirement sources
|
||||
|
||||
## License
|
||||
|
||||
Copyright (C) 2026 Melvin Strobl — GNU Affero General Public License v3.0 or
|
||||
Copyright (C) 2026 Melvin Strobl - GNU Affero General Public License v3.0 or
|
||||
later. See [LICENSE](LICENSE).
|
||||
|
||||
+2
-12
@@ -9,14 +9,7 @@ pip install fluksio
|
||||
fluksio serve
|
||||
```
|
||||
|
||||
and you're ready to go — `serve` signs you in itself and says where it put the
|
||||
token, so there is no login step. (`fluksio login` is for an engine somewhere
|
||||
else.)
|
||||
|
||||
Install it into the environment you already work in and your nodes run on that
|
||||
one, so everything you had imported is still importable. Fluksio keeps a SQLite
|
||||
database, a git repository of your flows and an artifact store in a `.fluksio`
|
||||
beside your code — one installation per project, found the way `.git` is.
|
||||
and you're ready to go.
|
||||
|
||||
## For data science
|
||||
|
||||
@@ -59,9 +52,6 @@ When everything is set, you can launch your first run as follows:
|
||||
fluksio run train --lr 0.05 --wait
|
||||
```
|
||||
|
||||
That syncs your code and then runs it, so after an edit the command is the same
|
||||
one again.
|
||||
|
||||
Checkout our [documentation](https://docs.fluksio.com/getting-started/data-science/) for more infos.
|
||||
|
||||
## Some other features
|
||||
@@ -80,7 +70,7 @@ Visit us on [fluksio.com](https://fluksio.com) or go straight to our [documentat
|
||||
|
||||
## License
|
||||
|
||||
Copyright (C) 2026 Melvin Strobl — [GNU Affero General Public License v3.0 or
|
||||
Copyright (C) 2026 Melvin Strobl - [GNU Affero General Public License v3.0 or
|
||||
later](https://www.gnu.org/licenses/agpl-3.0.en.html). Running a modified
|
||||
version over a network obliges you to offer its users the corresponding source
|
||||
(AGPL §13).
|
||||
|
||||
Reference in New Issue
Block a user