BraneTechnologies Documentation

Setting Up the Project #

Start by creating a new Gradle project that will serve as the foundation for your application:

$ mkdir apps
$ cd apps
$ gradle init

This initializes a Gradle project with the required configuration files, establishing the build environment for your Brane SDK application.

Configuring the Root build.gradle File #

The root build.gradle file configures the overall project settings and dependencies. Create this file at the project root with the following content:

/**
 * The buildscript block is where you configure the repositories and
 * dependencies for Gradle itself—meaning, you should not include dependencies
 * for your modules here. For example, this block includes the Brane plugins for
 * Gradle as a dependency because it provides the additional instructions Gradle
 * needs to build modules.
 */

buildscript {

    /**
     * The repositories block configures the repositories Gradle uses to
     * search or download the dependencies. Gradle pre-configures support for remote
     * repositories such as JCenter, Maven Central, and Ivy. You can also use local
     * repositories or define your own remote repositories. The code below defines
     * the Brane Repo as the repository Gradle should use to look for its dependencies.
     *
     */

    repositories {
        maven {
            url "s3://com.brane.repository.maven/release/"
            credentials(AwsCredentials) {
                accessKey = System.env.AWS_ACCESS_KEY_ID ?: findProperty('aws_access_key_id')
                secretKey = System.env.AWS_SECRET_ACCESS_KEY ?: findProperty('aws_secret_access_key')
            }
        }
        jcenter()
    }

    /**
     * The dependencies block configures the dependencies Gradle needs to use
     * to build your project. The following line adds the Brane plugins for Gradle
     * version 0.4.0 as a classpath dependency.
     */

    dependencies {
        classpath 'com.brane.plugins:brane-builder:2.0.1'
        classpath 'org.apache.velocity:velocity:1.7'

    }
}

/**
 * The allprojects block is where you configure the repositories and
 * dependencies used by all modules in your project, such as third-party plugins
 * or libraries. However, you should configure module-specific dependencies in
 * each module-level build.gradle file. ).
 */

allprojects {
    repositories {
        maven {
            url "s3://com.brane.repository.maven/release/"
            credentials(AwsCredentials) {
                accessKey = System.env.AWS_ACCESS_KEY_ID ?: findProperty('aws_access_key_id')
                secretKey = System.env.AWS_SECRET_ACCESS_KEY ?: findProperty('aws_secret_access_key')
            }
        }
        jcenter()
    }
}

Creating the settings.gradle File #

The settings.gradle file defines your project hierarchy. For this example, we’ll create a single application module:

rootProject.name = 'helloWorld'

include 'helloWorld'

Project Structure #

Create the following directory structure for your “Hello World” application:

helloWorld/
├── build.gradle
└── src
    └── main
        └── c
            └── main.c

This structure offers several advantages:

• Supports hierarchical organization for larger projects
• Follows standard Gradle conventions for source code location
• Enables automatic source discovery by the Brane SDK
• Facilitates easy addition of multiple modules or applications

Module-Level build.gradle Configuration #

Create a build.gradle file in the helloWorld directory to configure your application:

plugins {
    id 'com.brane.cpu.c-application'
}

version = '2.0.1'

application {
    targetMachines = [
            machines.linux.x86_64,
    ]
}

This configuration:

• Specifies Linux x86_64 as the target architecture
• Applies the Brane C application plugin
• Sets the application version

Creating the Main Application File #

Create a main.c file in the src/main/c directory with your application code:

#include <stdio.h>

int main() {
    printf("Hello world!\n");
    return 0;
}