Creating a new workspace

Note: this documentation is for a beta release of Caplin Trader 5. Features may change before the final release.

You create Caplin Trader 5 applications under a development workspace. You can create as many workspaces as you want, and create as many applications under a single workspace as you want.

Contents:

Requirements

To create a new development workspace, you require the Caplin Trader 5 ZIP file: caplintrader-5.0.0-<version>.zip

The beta release of the Caplin Trader 5 ZIP file is not available on the Caplin Downloads site. Contact your Caplin account manager for the latest version of the file.

Creating a new development workspace

To create a new Caplin Trader 5 development workspace, follow the steps below:

  1. Create a directory to hold the workspace:

    mkdir -p ~/src/ct-workspace
    
  2. Navigate to the new ct-workspace directory:

    cd ~/src/ct-workspace
    
  3. Initialise the workspace:

    caplin-cli init

    After initialisation, your new workspace has the following directory structure:

    ct-workspace/
    ├── apps/
    ├── packages/
    ├── packages-caplin/
    └── README.md
    Directory Contents
    apps The root directory for applications developed within this workspace. Each application has its own subdirectory under the apps directory.
    packages Local packages common to all applications in the workspace. To create your own packages, see Creating a new local package.
    packages-caplin Caplin Trader 5 packages. To install the packages, see step 4 below.
  4. Extract the Caplin Trader 5 ZIP file to the root directory of your development workspace.

    Note: contact your Caplin account manager for the latest version of the file caplintrader-5.0.0-beta-<version>.zip 

    After extracting the ZIP file, your development workspace has the following directory structure:

    ct-workspace/
    ├── apps/
    │   └── demo/
    ├── packages/
    ├── packages-caplin/
    │   ├── br/
    │   ├── br-component/
    │   ├── br-core/
    │   ├── br-formatting/
    │   ⋮  
    │   ├── sljs/
    │   ├── sljs-alerts/
    │   ├── topiarist/
    │   └── velocity/
    └── README.md

See also: