Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pavel-durov/ably.poc

poc with ably sdk
https://github.com/pavel-durov/ably.poc

Last synced: 2 days ago
JSON representation

poc with ably sdk

Awesome Lists containing this project

README

        

# TypeScript Template

## Getting started

```shell
$ npm install
```

## Environment

Define the following env variables (.envrc or other way)

```shell
export API_KEY=?
export HOST=?
export PORT=?
export QUEUE_NAME=?
```

## Run

```shell
$ tsx src/channels.ts
```

## Build

```shell
$ npm run build
```

## Test
```shell
$ npm run test
```

## Lint

```shell
$ npm run lint # lint check
$ npm run lint:fix # lint write
```

## Git hooks

### Tests

```shell
npx husky add .husky/pre-commit "npm test"
npx husky add .husky/pre-commit "npm run lint"
git add .husky/pre-commit
```

### Commit message

```shell
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit ${1}'
npm pkg set scripts.commitlint="commitlint --edit"
npx husky add .husky/commit-msg 'npm run commitlint ${1}'
```