open-index/open-npm huggingface dataset:
npm package: @microbs.io/app-ecommerce
Description: microbs app - ecommerce
Latest version: 0.2.12

[![Build Status](https://github.com/microbs-io/microbs-app-ecommerce/workflows/Commit/badge.svg?branch=main)](https://github.com/microbs-io/microbs-app-ecommerce/actions)
[![npm](https://img.shields.io/npm/v/@microbs.io/app-ecommerce?color=%2300B5AD&label=Latest)](https://www.npmjs.com/package/@microbs.io/app-ecommerce)
![Apache 2.0](https://img.shields.io/npm/l/@microbs.io/app-ecommerce?color=%23f6f8fa)

# microbs-app-ecommerce

This is the ecommerce app for microbs.
npm package: @microbs.io/plugin-kind
Description: microbs plugin - kind
Latest version: 0.2.2

[![Build Status](https://github.com/microbs-io/microbs-plugin-kind/workflows/Commit/badge.svg?branch=main)](https://github.com/microbs-io/microbs-plugin-kind/actions)
[![npm](https://img.shields.io/npm/v/@microbs.io/plugin-kind?color=%2300B5AD&label=Latest)](https://www.npmjs.com/package/@microbs.io/plugin-kind)
![Apache 2.0](https://img.shields.io/npm/l/@microbs.io/plugin-kind?color=%23f6f8fa)

# microbs-plugin-kind

## Contents

* [Usage](#usage)
* [Prerequisites](#prerequisites)
* [Configuration](#configuration)


## [](usage)Usage

This section documents the behavior of the `kind` plugin when using the [`CLI`](https://microbs.io/docs/usage/cli).

Before using the `kind` plugin you must have its [prerequisites](#prerequisites).

### `setup`

When running [`microbs setup [-k]`](https://microbs.io/docs/usage/cli/#setup), the `kind`
plugin runs `kind create cluster`. Currently, the `kind` plugin does not
configure the size of the cluster it deploys.

### `rollout`

The `kind` plugin is unaffected by [`microbs rollout`](https://microbs.io/docs/usage/cli#rollout).

### `destroy`

When running [`microbs destroy [-k]`](https://microbs.io/docs/usage/cli/#destroy), the `kind`
plugin runs `kind delete cluster`.


## [](prerequisites)Prerequisites

### Install the plugin

microbs installs this plugin automatically when you [install microbs](https://microbs.io/docs/overview/getting-started/).

To reinstall this plugin, run this command:

`microbs plugins install kind`

To upgrade this plugin to the latest version, run this command:

`microbs plugins update kind`

### Install dependencies

The `kind` plugin requires the following software dependencies on the same machine as microbs:

|Software|Version|
|------|-----|
|[kind](https://kind.sigs.k8s.io/docs/user/quick-start/)|0.12.0|


## [](configuration)Configuration

Currently, the `kind` plugin does not have any configurable settings.
npm package: @microbs.io/plugin-minikube
Description: microbs plugin - minikube
Latest version: 0.2.3

[![Build Status](https://github.com/microbs-io/microbs-plugin-minikube/workflows/Commit/badge.svg?branch=main)](https://github.com/microbs-io/microbs-plugin-minikube/actions)
[![npm](https://img.shields.io/npm/v/@microbs.io/plugin-minikube?color=%2300B5AD&label=Latest)](https://www.npmjs.com/package/@microbs.io/plugin-minikube)
![Apache 2.0](https://img.shields.io/npm/l/@microbs.io/plugin-minikube?color=%23f6f8fa)

# microbs-plugin-minikube

## Contents

* [Usage](#usage)
* [Prerequisites](#prerequisites)
* [Configuration](#configuration)


## [](usage)Usage

Before using the `minikube` plugin you must have its [prerequisites](#prerequisites).

### `setup`

When running [`microbs setup [-k]`](https://microbs.io/docs/usage/cli/#setup), the `minikube`
plugin runs `minikube start`.

After deploying an application with `microbs setup [--app]`, run
[`minikube tunnel`](https://minikube.sigs.k8s.io/docs/handbook/accessing/#using-minikube-tunnel)
in another terminal window to enable communications between your machine and the
application. You may need to run `minikube tunnel` as a `sudo` user for
applications that expose privileged ports, such as the
[`ecommerce`](https://microbs.io/docs/apps/ecommerce) app which exposes port `80`.

Currently, the `minikube` plugin does not configure the size of the cluster it
deploys. If you find that you need more capacity, [destroy](#/docs/usage/cli#destroy)
your current cluster and run:

```text
minikube config set memory NUM_MB && \
minikube config set cpus NUM_CPUS
```

### `rollout`

The `minikube` plugin is unaffected by [`microbs rollout`](https://microbs.io/docs/usage/cli#rollout).

### `destroy`

When running [`microbs destroy [-k]`](https://microbs.io/docs/usage/cli/#destroy), the `minikube`
plugin runs `minikube delete`.


## [](prerequisites)Prerequisites


### Install dependencies

The `minikube` plugin requires the following software dependencies on the same machine as microbs:

|Software|Version|
|------|-----|
|[minikube](https://kubernetes.io/docs/tasks/tools/#minikube)|1.25.2|

### Install the plugin

microbs installs this plugin automatically when you [install microbs](https://microbs.io/docs/overview/getting-started/).

To reinstall this plugin, run this command:

`microbs plugins install minikube`

To upgrade this plugin to the latest version, run this command:

`microbs plugins update minikube`


## [](configuration)Configuration

Currently, the `minikube` plugin does not have any configurable settings.
npm package: @microbs.io/plugin-slack
Description: microbs plugin - slack
Latest version: 0.2.1

[![Build Status](https://github.com/microbs-io/microbs-plugin-slack/workflows/Commit/badge.svg?branch=main)](https://github.com/microbs-io/microbs-plugin-slack/actions)
[![npm](https://img.shields.io/npm/v/@microbs.io/plugin-slack?color=%2300B5AD&label=Latest)](https://www.npmjs.com/package/@microbs.io/plugin-slack)
![Apache 2.0](https://img.shields.io/npm/l/@microbs.io/plugin-slack?color=%23f6f8fa)

# microbs-plugin-slack

## Contents

* [Usage](#usage)
* [Prerequisites](#prerequisites)
* [Configuration](#configuration)


## [](usage)Usage

Before using the `slack` plugin you must have its [prerequisites](#prerequisites).


### `setup`

When running [`microbs setup [-o]`](https://microbs.io/docs/usage/cli/#setup), the
`slack` plugin creates a channel in your Slack Workspace.

### `rollout`

The `slack` plugin is unaffected by [`microbs rollout`](https://microbs.io/docs/usage/cli#rollout).

### `destroy`

The `slack` plugin does not yet implement [`microbs destroy [-k]`](https://microbs.io/docs/usage/cli/#destroy).
You can delete your channel through the standard Slack interfaces such as the
Slack UI.


## [](prerequisites)Prerequisites


### Create Slack resources

You must create a [Slack workspace](https://slack.com/get-started#/create)
and obtain a [bot access token](https://api.slack.com/authentication/token-types#bot)
before using the `slack` plugin.

### Install the plugin

microbs installs this plugin automatically when you [install microbs](https://microbs.io/docs/overview/getting-started/).

To reinstall this plugin, run this command:

`microbs plugins install slack`

To upgrade this plugin to the latest version, run this command:

`microbs plugins update slack`


## [](configuration)Configuration

This section documents the `slack` plugin configurations for [config.yaml](https://microbs.io/docs/usage/configuration).

### Required fields

#### [](plugins.slack.bot_user_oauth_access_token)`plugins.slack.api_key`

The value of your [bot access token](https://api.slack.com/authentication/token-types#bot).

Example: `xoxb-999999999999-999999999999-gxnpd45mZZh76FzLfkpLP7Tj`