README
¶
FTL README 
Getting started
Install ftl, for example on macos:
brew tap TBD54566975/ftl && brew install ftl
Create a sample project (kotlin)
mkdir myproject
cd myproject
git init .
ftl init kotlin . alice
Serve FTL in a separate terminal
ftl serve
Deploy and test the module
ftl deploy ftl-module-alice
ftl call alice.echo '{"name": "Mic"}'
Project Resources
| Resource | Description |
|---|---|
| CODEOWNERS | Outlines the project lead(s) |
| CODE_OF_CONDUCT.md | Expected behavior for project contributors, promoting a welcoming environment |
| CONTRIBUTING.md | Developer guide to build, test, run, access CI, chat, discuss, file issues |
| GOVERNANCE.md | Project governance |
| LICENSE | Apache License, Version 2.0 |
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Timestamp = "0"
Timestamp of FTL binary (set by linker).
View Source
var Version = "dev"
Version of FTL binary (set by linker).
Functions ¶
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
backend
|
|
|
controller/dal
Package dal provides a data abstraction layer for the Controller
|
Package dal provides a data abstraction layer for the Controller |
|
controller/scheduledtask
Package scheduledtask implements a task scheduler.
|
Package scheduledtask implements a task scheduler. |
|
runner
Package runner contains a server that implements the RunnerService and proxies VerbService requests to user code.
|
Package runner contains a server that implements the RunnerService and proxies VerbService requests to user code. |
|
schema/strcase
Package strcase provides programming case conversion functions for strings.
|
Package strcase provides programming case conversion functions for strings. |
|
Package buildengine provides a framework for building FTL modules.
|
Package buildengine provides a framework for building FTL modules. |
|
cmd
|
|
|
common
|
|
|
configuration
Package configuration is the FTL configuration and secret management API.
|
Package configuration is the FTL configuration and secret management API. |
|
examples
|
|
|
echo
Module
|
|
|
online-boutique/services/ad
Module
|
|
|
time
Module
|
|
|
compile
Package compile compiles FTL Go module source into a deployable executable.
|
Package compile compiles FTL Go module source into a deployable executable. |
|
encoding
Package encoding defines the internal encoding that FTL uses to encode and decode messages.
|
Package encoding defines the internal encoding that FTL uses to encode and decode messages. |
|
ftl/ftltest
Package ftltest contains test utilities for the ftl package.
|
Package ftltest contains test utilities for the ftl package. |
|
automaxprocs
Package automaxprocs sets GOMAXPROCS to match Linux container CPU quota.
|
Package automaxprocs sets GOMAXPROCS to match Linux container CPU quota. |
|
goast
Package goast provides a useful visitor for the Go AST.
|
Package goast provides a useful visitor for the Go AST. |
Click to show internal directories.
Click to hide internal directories.