Platform

To get started, install Bit on your machine:

$npx @teambit/bvm install

Copied

For a more advanced installation guide, head to our installation section.

A workspace is used to create and maintain a set of independent components and apps, and compose them one to the other.

Your workspace maintains a number of components. One of these components is also an app. Run the app by using the following command:

You can list the apps and platforms available on your workspace using bit app list. Head to the apps section to learn more on running apps.

Run the Workspace UI to preview your components and inspect your workspace:

$bit start

Copied

The workspace UI displays all components maintained by your workspace. Use it to explore your components' preview, documentation, dependency graph, version history, and more.

You can create new components using our official templates. Our templates includes apps, backend services, UI components and more to help stitch your architecture:

$bit templates

Copied

Head to the create components section to learn on creating components.

Components are used as standard packages. Use an import statement with the requested component package name to use a component:

import { Announcement } from '@my-org/my-project.entities.announcement';
Copied

You can install external packages or components using bit install. Learn more on using components.

$bit install lodash

Copied

You can use bit test, lint and other commands to operate the components on your workspace. Find useful commands on the CLI reference.

Run the following to verify there are no issues preventing Bit from snapping each component as an independent unit that is uncoupled from the rest of the workspace:

$bit status

Copied

The output should confirm all components are ok to be snapped. The components' status is currently new as they were forked by the workspace starter and not imported.

Scopes help organize components in a shared domain of responsibility. For example, the analytics scope includes all components that provide analytics services, and the design scope includes the services for our design language.

Run the following to log in to your bit.cloud account and create your free scope:

$bit login

Copied

If the name you chose is different than the name you chose while creating your workspace, then use the following command to update your components to the newly created account and scope:

$bit scope rename my-org.my-project my-org.my-scope-name --refactor

Copied

Run the following to tag your components with a semantic release version:

$bit tag --message "initial tag"

Copied

You can also use snap to create a new version for the component without assigning with a semantic release.

By default, components are built using bit.cloud's Ripple CI. However, you can run the components' build locally by adding the --build flag, or use your own CI platform. To learn more see Set up CI.

Export the newly created versions to your remote scope by running the following command:

$bit export

Copied

Head over to your bit.cloud account to see your components build progress. Once the build process is completed, you components are deployed and ready to be used!

• Create components
• Install components
• Deploy your app
• Configure your CI of choice
• Create change requests