asyncapi-react icon indicating copy to clipboard operation
asyncapi-react copied to clipboard

Make playground available as a separate npm package

Open kaibra opened this issue 4 years ago • 19 comments

Description This repository provides two nice tools: a react-component to visualize asynapi-specs and a playground for writing async-api specs in an editor and see the results visualized. The playground is currently only maintained for local development as far as I understand and can't be accessed apart from cloning this repository. https://github.com/asyncapi/playground is a server-side version of the playground ?!

I suggest to publish the "playground" of this repository (could be renamed to asyapi-editor) as (at least) a react-component as well, since I think it is a nice tool which can be useful for others.

To increase accessibility of the package, it would be worth to think about providing a dependecy free bundle also (like: https://www.npmjs.com/package/swagger-editor-dist).

As already mentioned in

https://github.com/asyncapi/asyncapi-react/pull/76 https://github.com/asyncapi/asyncapi-react/pull/75

Regards,

Kai

Reasons This feature would make another tool available in the asyncapi space, which is already there, but inaccessible. It would be similar to https://www.npmjs.com/package/swagger-editor I think developers coming from OpenAPI would appreciate to find such a tool.

Attachments none

kaibra avatar Sep 22 '20 08:09 kaibra

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.

github-actions[bot] avatar Sep 22 '20 08:09 github-actions[bot]

The current AsyncAPI Playground is here https://playground.asyncapi.io/ Playground for this react component is published here https://asyncapi.github.io/asyncapi-react/

Or you say someone would prefer to use react playground locally instead of the official one?

derberg avatar Sep 22 '20 10:09 derberg

Or you say someone would prefer to use react playground locally instead of the official one?

Yes, exactly. People could embed it in their own applications for example.

kaibra avatar Sep 22 '20 11:09 kaibra

I might second this. I'm currently trying to wrap different documentation tools into a single application (Rails 6) and I think the playground would be a good addition.

By now I think I can dig through the .ts files in the playground and make it work but that would leave me behind master/main changes.

sebastian-palma avatar Nov 07 '20 16:11 sebastian-palma

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] avatar Jan 07 '21 00:01 github-actions[bot]

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] avatar Mar 09 '21 00:03 github-actions[bot]

still valid, we just need some help from the community

derberg avatar Mar 09 '21 08:03 derberg

Second that. Same use-case here. Could even be part of the @asyncapi/react-component package, as far as I'm concerned.

SimonAlling avatar Mar 24 '21 11:03 SimonAlling

I also need editor in my angular application

bidadh avatar May 04 '21 12:05 bidadh

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] avatar Jul 04 '21 00:07 github-actions[bot]

FYI, I know that @magicmatatjahu is working on it atm. Actually, he is building a new editor/playground from scratch :)

derberg avatar Jul 05 '21 09:07 derberg

@derberg it was supposed to be a surprise 😅

magicmatatjahu avatar Jul 05 '21 09:07 magicmatatjahu

🤷🏼

derberg avatar Jul 05 '21 09:07 derberg

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] avatar Sep 06 '21 00:09 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Jan 05 '22 00:01 github-actions[bot]

related https://github.com/asyncapi/asyncapi-react/issues/273

derberg avatar Jan 11 '22 15:01 derberg

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar May 12 '22 00:05 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Sep 24 '22 00:09 github-actions[bot]

@kaibra Hey, playground is just internal integration tool for react component development. We will not push it to npm.

Instead, we have https://github.com/asyncapi/studio/ that we push out to npm regularly. Can you have a look if there is something more we need to do to make the studio more usable as a dependency?

derberg avatar Sep 26 '22 07:09 derberg

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Jan 26 '23 00:01 github-actions[bot]