Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/live demo #563

Merged
merged 2 commits into from
Feb 22, 2024
Merged

Feat/live demo #563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8d5b74
chore: removed unused stuff from eslintrc
flamewow Feb 22, 2024
7cc7d8c
added docs/live-demo
flamewow Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .eslintrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
},
"ignorePatterns": [
".eslintrc.js",
"src/db/migrations"
],
"rules": {
"@typescript-eslint/interface-name-prefix": "off",
Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
Generate [AsyncApi](https://www.asyncapi.com/) documentation (for event-based services, like websockets) in a similar
to [nestjs/swagger](https://github.com/nestjs/swagger) fashion.

[Documentation example](https://playground.asyncapi.io/?load=https://raw.githubusercontent.com/asyncapi/asyncapi/v2.1.0/examples/simple.yml)
### [Live Preview](https://flamewow.github.io/nestjs-asyncapi/live-preview)

[AsyncApi playground](https://playground.asyncapi.io/?load=https://raw.githubusercontent.com/asyncapi/asyncapi/v2.1.0/examples/simple.yml)

## Installation

Expand Down Expand Up @@ -92,4 +94,4 @@ class DemoController {
For more detailed examples please check out https://github.com/flamewow/nestjs-asyncapi/tree/main/sample sample app.

<h5>Do you use this library and like it? Don't be shy to give it a star
on <a href="https://github.com/flamewow/nestjs-asyncapi">github <span style="color:yellow;">★</span></a></h3>
on <a href="https://github.com/flamewow/nestjs-asyncapi">github <span>★</span></a></h3>
Loading