Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ably-labs/async-api-template-ably-nodejs
Node.js Ably template for the AsyncAPI Generator
https://github.com/ably-labs/async-api-template-ably-nodejs
ably ably-js asyncapi nodejs template
Last synced: about 1 month ago
JSON representation
Node.js Ably template for the AsyncAPI Generator
- Host: GitHub
- URL: https://github.com/ably-labs/async-api-template-ably-nodejs
- Owner: ably-labs
- Created: 2020-10-27T15:41:10.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-08T17:08:46.000Z (over 1 year ago)
- Last Synced: 2024-04-17T15:32:35.597Z (8 months ago)
- Topics: ably, ably-js, asyncapi, nodejs, template
- Language: JavaScript
- Homepage:
- Size: 1.14 MB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node.js Ably template for the AsyncAPI Generator
## Usage
```
ag asyncapi.yaml @asyncapi/nodejs-ably-template -o output -p server=production
```
If you don't have the AsyncAPI Generator installed, you can install it like this:
```
npm install -g @asyncapi/generator
```
## Supported parameters
|Name|Description|Required|Example|
|---|---|---|---|
|server|The server you want to use in the code.|Yes|`production`|
## Supported protocols
* [Ably Realtime](https://github.com/ably/ably-js/)
## Running the produced code
Navigate to the output directory, and install the required npm modules with `npm install`. You can then run the code with `node src/api/index.js`.