search

asyncapi / nodejs-template

This template generates a server using your AsyncAPI document. It supports multiple different protocols, like Kafka or MQTT. It is designed in the way that generated code is a library and with it's API you can start the server, send messages or register a middleware for listening incoming messages. Runtime message validation included.
40 stars 29 forks source link

Create README for this template #4

Closed fmvilas closed 3 years ago

fmvilas commented 4 years ago

Make sure we don't forget to include:

  1. How to install it.
  2. How to use it.
  3. The params it supports.
  4. The requirement of operationId on each operation (otherwise, the code would not work).
  5. This README should serve as a template for the rest of the generator templates.
github-actions[bot] commented 4 years ago

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

derberg commented 4 years ago

would be awesome to have a template of the readme for all repos for consistency reasons, especially template readmies

fmvilas commented 4 years ago

Good point. Added it to the description.

github-actions[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

github-actions[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

github-actions[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

derberg commented 4 years ago

video on how to approach this issue https://youtu.be/Iqs_2BiNEEo?t=1265

derberg commented 3 years ago

last part of requirement, turning this readmy into a readme template, is covered by https://github.com/asyncapi/template-for-generator-templates/pull/1

github-actions[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

github-actions[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

KhudaDad414 commented 3 years ago

I want to work on this. please assign it to me. I think there is a lot of things that I can learn by doing this.

derberg commented 3 years ago

@KhudaDad414 assigned. I think the best is to have a look at this PR where I added a readme for another nodejs template -> https://github.com/asyncapi/nodejs-ws-template/pull/53/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5

Let me know if you need something more

KhudaDad414 commented 3 years ago

@derberg thanks. I'll start working on this.

asyncapi-bot commented 3 years ago

:tada: This issue has been resolved in version 0.10.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: