App Structure

An App's structure is fairly simple: a directory containing a run.sh file, nested under the apps/ directory.

SyftBox
├── ...
└── apps
    └── my_app
        ├── ...
        └── run.sh

The run.sh script will run every 10 seconds. This allows behavior allows you to build all sorts of patterns for your Apps.

See the following guides for more details on writing your Apps:

• How to write an App from scratch
• How to run Apps in SyftBox

Caveats

One caveat is that SyftBox will create a logs directory nested under your App directory, where it will dump all the logs generated by your App (see How to monitor your App on SyftBox).

SyftBox
├── ...
└── apps
    └── my_app
        ├── ...
        ├── logs    <- this will be generated by SyftBox
        └── run.sh

That is the only restricted directory name, which you shouldn't use when writing your App.