F-AIR Data Space Application Templates

Official templates for building data space applications compatible with the F-AIR platform. Each template implements the F-AIR HTTP protocol and provides a ready-to-use project structure with configuration, tests and Docker support.

Templates

Template	Language	Framework	Path
TypeScript	TypeScript (Node.js)	Express	typescript/
Python	Python 3.12+	Flask	python/

Both templates include:

• Full F-AIR API implementation (task management, data push/pull, file upload, analysis results)
• WebSocket support for real-time data streaming and analysis result notifications
• MongoDB integration for data persistence
• Redis integration for pub/sub across workers
• Secrets management (environment variables, SOPS)
• Authentication via bearer token
• Docker Compose setup with MongoDB, Redis and the application
• Test suite

Quick Start

TypeScript

cp -r typescript /path/to/my-data-app
cd /path/to/my-data-app
cp .env.example .env
docker compose up --build

Python

cp -r python /path/to/my-data-app
cd /path/to/my-data-app
cp .env.example .env
docker compose up --build

Customizing Your App

Each template includes an example data space application. To build your own:

1. Define your app metadata (parameters, descriptions).
2. Define your outputs.
3. Implement your inputs (structured, unstructured, file-based, real-time).
4. Implement your analysis results.
5. Wire everything in the main data app file.

Refer to each template's README for language-specific instructions.

Protocol Documentation

The full F-AIR data space application protocol specification is available in the docs folder:

• Data space application protocol — HTTP API and interaction protocol between the connector and data space applications
• Real-time WebSocket protocol — WebSocket message format for real-time data streaming
• API definition (Swagger) — OpenAPI/Swagger specification

License

See LICENSE.