NOTE: The following instructions apply while the project is a private repo. This will build the Functions server and the CLI tool directly from the repo instead of using pre-built containers. Once the project is public, these steps will be unnecessary.

# Build and Install CLI tool
cd fn
make dep # just once
make install

# Build and Run Functions Server
cd ..
make dep # just once
make run # will build as well

Your First Function

Functions are small but powerful blocks of code that generally do one simple thing. Forget about monoliths when using functions, just focus on the task that you want the function to perform.

The following is a simple Go program that outputs a string to STDOUT. Copy and paste the code below into a file called func.go. Currently the function must be named func.your_language_extention (ie func.go, func.js, etc.)

package main

import (
	"fmt"
)

func main() {
	fmt.Println("Hello from Oracle Functions!")
}

Now run the following CLI commands:

# Create your first application
fn apps create myapp

# Initialize your function
# This detects your runtime from the code above and creates a func.yaml
fn init <DOCKERHUB_USERNAME>/hello

# Test your function
# This will run inside a container exactly how it will on the server
fn run

# Deploy your functions to the Oracle Functions server (default localhost:8080)
# This will create a route to your function as well
fn deploy myapp

Now you can call your function:

curl http://localhost:8080/r/myapp/hello

Or in a browser: http://localhost:8080/r/myapp/hello

That's it! You just deployed your first function and called it. Now to update your function you can update your code and run fn deploy myapp again.

To Learn More

Walk through the following tutorial series
See our full documentation
View our examples directory
You can also write your functions in AWS Lambda format

Get Involved

TODO: Slack or Discord community
Learn how to contribute
See milestones for detailed issues

User Interface

This is the graphical user interface for Oracle Functions. It is currently not buildable.

docker run --rm -it --link functions:api -p 4000:4000 -e "API_URL=http://api:8080" treeder/functions-ui

For more information, see: https://github.com/treeder/functions-ui

Next up: Walk through the following tutorial series -->

Languages

Go 97.4%

Shell 1.2%

Ruby 0.5%

Makefile 0.4%

Dockerfile 0.4%

Other 0.1%