search

asyncapi / php-template

PHP Template for AsyncAPI generator
Apache License 2.0
10 stars 6 forks source link

Plan for standing up PHP template and continued development #162

Open emilianozublena opened 1 year ago

emilianozublena commented 1 year ago

Reason/Context

Now that there seems to be interest in this template, we need to fix a couple of things, probably add more support for other async driven technologies (currently it only supports RabbitMQ) and other stuff we deem important.

In order for us to start chatting about next steps i've started this issue @Ferror, so please let me know your thoughts or where would you like to contribute.

Initially i had these in mind:

github-actions[bot] commented 1 year ago

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Maniktherana commented 1 year ago

Hey @emilianozublena I'm new here, looking for ways to contribute to AsyncAPI. Is there anything missing here that I can help out with? I'm decently familiar with Python and the MERN stack and was told to touch base with you. I'm also interested in gsoc or the asyncapi mentorship coming up. Currently working on fixing broken links.

emilianozublena commented 1 year ago

Hi @Maniktherana ! thanks for reaching out. Right now the most important thing is to get merged the changes i sent a couple of minutes ago, which basically switches the semantics of Publisher/Subscriber. When i initially coded the template i got those wrong (was thinking from a "server perspective" instead of the "client perspective" which is the one that's taken for granted on AsyncAPI v2). If you want to give it a review and see if you spot anything wrong, That'd be helpful.

Outside of that, i think the next steps are basically adding more support to other tech stacks (right now this template only supports RabbitMQ) and eventually migrating from Nunjucks to ReactJS template engine.

Nevertheless, any contribution are very much appreciated :)

Maniktherana commented 1 year ago

@emilianozublena I'd like to work on the React template if possible. Any resources for that?

emilianozublena commented 1 year ago

sorry for the late response. I'm not entirely sure about those resources, but we can ask @derberg to give us a hint here... Do you know which would the best place to start reading and preparing a version of this template with the react template engine? thx bud!

derberg commented 1 year ago

hey folks, sorry but I don't get what React has to do here with the PHP template. I'm not very familiar with PHP 😅 you mean like enable docs rendering on one of the endpoints or?

emilianozublena commented 1 year ago

i was referring to how the template is built. Right now this template is still using the old nunjucks approach and, correct me if i'm wrong, but the new approach on all templates is through React, right?

derberg commented 1 year ago

oh, ups, right, I totally forgot about it 😄 yes, React render engine is the future. Rewriting current template to react engine is a great task, not easy, but something that would be a great candidate for mentorship program. I could help here in regards to how React engine works and how to proceed with rewrite, and @emilianozublena you would be very much needed on the PHP side, to validate if there is no regression introduced during rewrite 😅 (probably some tests should be introduced beforehand.

emilianozublena commented 1 year ago

Totally, that makes sense to me. i think in this case the best would be: 1) Me to write tests for the actual PHP code that is right now working 2) start the work to migrate to react template engine

Right?

derberg commented 1 year ago

that would definitely be recommended path

github-actions[bot] commented 1 year ago

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: