# channel-box

> | recommond using node `v16-17` ## Setup 1. clone this repo 2. create a `.env` file in the root project dir (contact me for keys if you want the global database!) 3. `npm i` 4. `npm link` 5. 'run box --help' for a list of commands

Latest version **1.0.0** (published 2023-02-08) · ISC license · 0 weekly downloads

## Install

```sh
npm install channel-box
pnpm add channel-box
yarn add channel-box
bun add channel-box
```

Provides the command `box`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-02-08 |
| First published | 2023-02-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Sevan Golnazarian |
| Maintainers | sevanbadal |
| Keywords | terminal, chat, messaging, terminal-app |

## Links

- npm: https://www.npmjs.com/package/channel-box
- Repository: https://github.com/SevanBadal/box
- Homepage: https://github.com/SevanBadal/box#readme
- Issues: https://github.com/SevanBadal/box/issues
- npm.io page: https://npm.io/package/channel-box

## Dependencies (2)

- [dotenv](https://npm.io/package/dotenv.md) ^16.0.3
- [@supabase/supabase-js](https://npm.io/package/@supabase/supabase-js.md) ^2.7.1

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-02-08

## README

| recommond using node `v16-17`
## Setup
1. clone this repo
2. create a `.env` file in the root project dir (contact me for keys if you want the global database!)
3. `npm i`
4. `npm link`
5. 'run box --help' for a list of commands

## Self Hosted
- create a supabase project with the following tables
    - `channel`
        - `created_at`
        - `name`::Text
    - `message` 
        - `receiver`::Text (setup as foreign key on channel if you want)
        - `sender`::Text  (setup as foreign key on channel if you want)
        - `channel`::Text
- file in your own keys in the `.env` file

ex: 
```bash
box dev "$(ls ./some/dir)" # sends the out put of a bash command to the dev channel
```

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