Workspace Starters

Workspace starters are pre-configured templates that you can use to scaffold a new workspace.

Use the `new` command to use a starter. For example:

$bit new vue my-vue-workspace --env bitdev.vue/vue --default-scope my-org.my-scope

Copied

Starters may include various items that can help you quickly create standardized projects. Some ideas for what starters may contain:

• Pre-configured workspace.jsonc.
• Pre-configured dependencies.
• Imported or forked starter components.

And anything else you may need to get started quickly and consistently.

To create a workspace starter we recommend starting from forking one of the default starters:

$bit fork bitdev.vue/templates/vue-starters templates/my-vue-starter

Copied

Now you can modify and maintain your own starter.
To add to your custom dev environment, add an import statement and register to the array of starters:

import { VueWorkspaceStarter } from '@my-org/my-scope.templates.my-vue-starter';
export class MyVueEnv extends VueEnv {
  starters() {
    return StarterList.from([VueWorkspaceStarter.from({})]);
  }
}
Copied

You can locally test your starters, before exporting, by running bit new with the path to your starter location.

bit new my-template-name my-new-workspace-name --aspect the-env-that-registers-starter --load-from path/to/workspace-with-template-env
Copied

{
  "teambit.generator/generator": {
    "envs": ["my-org.my-scope/envs/my-vue-env"]
  }
}
Copied

• Starter configuration