Wonderland Engine Components

https://github.com/wonderlandengine/components

Admin

Wonderland Engine's official component library provides reusable building blocks for creating...

Tokens:286

Snippets:5

Trust Score:7

License:MIT

Update:1 year ago

Show doc for...

Tokens:

Raw

### Install Development Dependencies

Source: https://github.com/wonderlandengine/components/blob/main/README.md

Installs all necessary dependencies required for developing and contributing to the Wonderland Engine components library.

```bash
npm install
```

--------------------------------

### Install Components

Source: https://github.com/wonderlandengine/components/blob/main/README.md

Installs the Wonderland Engine components library into your project's package using npm. This is often pre-configured in project templates.

```bash
npm i --save @wonderlandengine/components
```

--------------------------------

### Run Tests with Custom Deploy Folder

Source: https://github.com/wonderlandengine/components/blob/main/README.md

Runs the component tests while specifying a custom deploy folder using the `DEPLOY_FOLDER` environment variable. This is useful for testing integration with specific project setups.

```bash
DEPLOY_FOLDER="../../some/deploy" npm run test:watch
```

--------------------------------

### Build TypeScript Code

Source: https://github.com/wonderlandengine/components/blob/main/README.md

Compiles the TypeScript source code for the components. The `build:watch` script recompiles automatically when changes are detected.

```bash
npm run build:watch
```

--------------------------------

### Run Tests

Source: https://github.com/wonderlandengine/components/blob/main/README.md

Executes the automated tests for the components. The `test:watch` script runs tests and re-runs them upon detecting file changes.

```bash
npm run test:watch
```

Tokens:

Raw