Skip to content
ArtificialFlow

Developer guide

Clone the repository, start the one Compose file, and run the check that matches the change. Full SDKs are Node.js, .NET, and Java. Python and Go are workers.

What you need

git clone --depth 1 --branch release/v1.2.0 https://github.com/artificialflow/artificialflow.git
cd artificialflow
go mod download
npm --prefix frontend ci
npm --prefix clients/nodejs-sdk ci

make up
make build-backend
npm --prefix frontend run dev

make up builds images from the checkout and starts Postgres, Elasticsearch, Kafka, Debezium, and the ArtificialFlow services. IAM is off unless you set IAM_DEPLOYMENT_MODE=true and the issuer URLs. make up-release pulls published images and starts them without building. It does not add a second Compose file. Migrations and Debezium registration run when the stack starts. The frontend dev server listens on port 5173.

Fast checks

go test ./backend/...
npm --prefix frontend test
npm --prefix clients/nodejs-sdk test
make sdk-dotnet
make sdk-java
make smoke
make validate-helm

Deeper checks

make test-bpmn-matrix
make worker-conformance
make cqrs-e2e-smoke
make cqrs-parity-check
make test-integration
make test-e2e
make test-security
make release-dry-run

Worker conformance and the integration suite need a running stack. The quality-gates document in the repository lists which check belongs to which kind of change. The HTTP contract, including Swagger and Postman, is the HTTP API guide.