# @dcl/mini-comms

> ## Getting Started

Latest version **1.0.0** (published 2022-10-05) · 0 weekly downloads

## Install

```sh
npm install @dcl/mini-comms
pnpm add @dcl/mini-comms
yarn add @dcl/mini-comms
bun add @dcl/mini-comms
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-10-05 |
| First published | 2022-09-20 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 20 |
| Unpacked size | 119.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | decentralandbot |

## Links

- npm: https://www.npmjs.com/package/@dcl/mini-comms
- npm.io page: https://npm.io/package/@dcl/mini-comms

## Dependencies (20)

- [ws](https://npm.io/package/ws.md) ^8.8.1
- [mitt](https://npm.io/package/mitt.md) ^3.0.0
- [@dcl/rpc](https://npm.io/package/@dcl/rpc.md) ^1.0.3
- [ts-proto](https://npm.io/package/ts-proto.md) ^1.117.0
- [@types/ws](https://npm.io/package/@types/ws.md) ^8.5.3
- [bufferutil](https://npm.io/package/bufferutil.md) ^4.0.6
- [@dcl/crypto](https://npm.io/package/@dcl/crypto.md) ^3.2.1
- [@dcl/schemas](https://npm.io/package/@dcl/schemas.md) ^5.21.0
- [@dcl/protocol](https://npm.io/package/@dcl/protocol.md) https://sdk-team-cdn.decentraland.org/@dcl/protocol/branch//dcl-protocol-1.0.0-3146783658.commit-c506a2a.tgz
- [protoc-gen-dcl](https://npm.io/package/protoc-gen-dcl.md) ^1.0.0-20220109214200.commit-f45e34a
- [google-protobuf](https://npm.io/package/google-protobuf.md) ^3.19.1
- [@types/google-protobuf](https://npm.io/package/@types/google-protobuf.md) ^3.15.6
- [@dcl/catalyst-contracts](https://npm.io/package/@dcl/catalyst-contracts.md) ^3.0.0
- [@well-known-components/logger](https://npm.io/package/@well-known-components/logger.md) ^3.0.0
- [@well-known-components/metrics](https://npm.io/package/@well-known-components/metrics.md) ^2.0.0
- [@well-known-components/interfaces](https://npm.io/package/@well-known-components/interfaces.md) ^1.1.2
- [@well-known-components/http-server](https://npm.io/package/@well-known-components/http-server.md) ^1.1.5
- [@well-known-components/nats-component](https://npm.io/package/@well-known-components/nats-component.md) ^2.0.0
- [@well-known-components/pushable-channel](https://npm.io/package/@well-known-components/pushable-channel.md) ^1.0.3
- [@well-known-components/env-config-provider](https://npm.io/package/@well-known-components/env-config-provider.md) ^1.2.0

## Recent versions

- 1.0.0 (latest) — 2022-10-05
- 1.0.1-20230216163137.commit-a4c75be (next) — 2023-02-16
- 0.0.0-20221005164512.commit-4be8ff6 — 2022-10-05
- 0.0.0-20221005163306.commit-20d55f1 — 2022-10-05
- 0.0.0-20221005163000.commit-2a74ee8 — 2022-10-05
- 0.0.0-20221005162713.commit-fa7a009 — 2022-10-05
- 0.0.0-20221005162651.commit-ce0e310 — 2022-10-05
- 0.0.0-20220930000829.commit-192ab3e — 2022-09-30
- 0.0.0-20220929234746.commit-13c9bb6 — 2022-09-29
- 0.0.0-20220929232042.commit-edbdf08 — 2022-09-29
- 0.0.0-20220928224552.commit-59d651e — 2022-09-28
- 0.0.0-20220928212311.commit-7bfefdd — 2022-09-28
- 0.0.0-20220928201244.commit-0c8631c — 2022-09-28
- 0.0.0-20220928193933.commit-e5aaf36 — 2022-09-28
- 0.0.0-20220928193552.commit-2cdb511 — 2022-09-28
- … 15 more at https://npm.io/package/@dcl/mini-comms/versions

## README

# Minimum Viable Comms - Reference implementation of RFC-5

## Getting Started

### Dependencies

- Node >= v16

### Installation

Install Node dependencies:

```
make install
```

### Usage

Build and start the project:

```
make build
make start
```

### Test

Run unit and integration tests:

```
make build
make test
```

### Environment Variables

#### Server

- `HTTP_SERVER_PORT`: (Defaults to 3000)
- `HTTP_SERVER_HOST`: (Defaults to 0.0.0.0)

---
_Source: https://npm.io/package/@dcl/mini-comms · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._