Create create-template in AsyncAPI organization

[jonaslagoni]

Reason/Context

Stumbled upon this and thought it would be perfect for the generator. We could offer a way to use the init function which will allow people to more quickly setup new templates.

By creating create-template in the AsyncAPI scope we can do the following example commands:

• npm init @asyncapi/template --react
• npm init @asyncapi/template --nunjucks
• npm init @asyncapi/template

Description

This will significantly speed up the process of creating new ones and make it more accessible for people. This is similar to what React have - https://github.com/facebook/create-react-app

[magicmatatjahu]

I think that we should move this issue to the CLI repo. What do you think @jonaslagoni?

[jonaslagoni]

I think that we should move this issue to the CLI repo. What do you think @jonaslagoni?

I am not sure the CLI will be able to do this in a way it makes sense. Cause otherwise, we would need to run something like npm init @asyncapi/cli --template --react instead 🤔 Not sure we want to overcomplicate it? The @asyncapi/template repo could of course be used by the CLI repo to enable it natively.

Another thought is whether npm init would be needed if it can be done through the CLI? 🤔

[magicmatatjahu]

We can reuse the https://github.com/asyncapi/create-glee-app pattern to create the template for templates (LOL 😄 ) and then we can even use npx:

npx @asyncapi/template --react

Another thought is whether npm init would be needed if it can be done through the CLI? 🤔

No, but then we should have option to generate template without AsyncAPi doc, to reuse our generator.

npx @asyncapi/cli generate --template @asyncapi/template -p engine=react

or something like that

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴
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 ❤️

[derberg]

we already have template for templates, why not rework it to support it, I like the idea

[jonaslagoni]

we already have template for templates, why not rework it to support it, I like the idea

That could be an idea, yes!

[github-actions]

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

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 ❤️

[derberg]

shouldn't we move it to CLI repo?

[github-actions]

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

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 ❤️

[jonaslagoni]

We should yes 😄 @derberg I don't have permissions for it 🙂

[github-actions]

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

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 ❤️

[derberg]

I think we should follow the same direction that will be done with #418

[Shurtu-gal]

@derberg @jonaslagoni can I work on this?

[derberg]

yeah, but problem is not the implementation, we need a clear definition of the project that we would like to have generated with this new command. Some brainstorming session is kinda needed

[github-actions]

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

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 ❤️

[Shurtu-gal]

Still Relevant 🤝

[github-actions]

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

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 ❤️

[Shurtu-gal]

Still relevant 🤝

[AayushSaini101]

I want to work on this. :)

Thank you @Amzani for accepting the suggestion for sumitting this issue for Q3 Bounty Program. Here is my past experience in CLI and Past Bounty Issues:

• https://github.com/asyncapi/cli/pulls?q=is%3Apr+author%3AAayushSaini101+is%3Aclosed
• chore: support cli to fetch private templates #1399 [ Maintainer Onboarding task]
• Created a new CLI command feat: added new evaluate command to check the score of the asyncapi document #1413
  Last Completed Bounty Completed Issue:
• feat: allow generator to pull from private npm repo generator#1061 [Advanced]
• ci: add workflow to enable voting community#1120 [ Medium]
• docs: add instruction how voting automation works community#1155 Doc

[DhairyaMajmudar]

Hi @derberg @jonaslagoni I would love to work on this issue, actually I am developing a similar kind of npm package https://github.com/DhairyaMajmudar/majirya-cli

This package is a CLI Tool which simplifies mern stack and T3 stack web development.

[Amzani]

Hi @DhairyaMajmudar @AayushSaini101 was the first to express his interest in working on this issue.
Feel free to pick the other issues in the project.

Thanks

[DhairyaMajmudar]

Sure looking forward to apply for an another issue, thank you : )

[AayushSaini101]

We can implement a command that is asyncapi init that will generate a template for the user, and we have already have template of template structure https://github.com/asyncapi/template-for-generator-templates we can simply use it @Amzani @Souvikns

[aeworxet]

Bounty Issue's service comment

Text labels: bounty/2024-Q3, bounty/advanced, bounty/coding
First assignment to third-party contributors: 2024-06-21 00:00:00 UTC+12:00
End Of Life after: 2024-07-31 23:59:59 UTC-12:00

@asyncapi/bounty_team

The Bounty Program is not a Mentorship Program. The accepted level of Bounty Program Participants is Middle/Senior.

Third-party contributors should coherently articulate how they are going to approach the resolution process when expressing a desire to work on this Bounty Issue.

[AayushSaini101]

The current command to generate the glee project is asyncapi new glee --name , and we need to generate only for react engine template because it is more efficient. In that case, we can introduce the new command that is :
asyncapi new template --name .
and the structure of the template will be:

asyncapitemplate
  -->template
 ------>index.js 
  --->package.json

Reference template format for react engine: https://www.asyncapi.com/docs/tools/generator/template-development. thoughts @peter-rr @jonaslagoni I will create a PR after that

[aeworxet]

Bounty Issue's Timeline

Complexity Level	Assignment Date (by GitHub)	Start Date (by BP Rules)	End Date (by BP Rules)	Draft PR Submission	Final PR Merge Start	Final PR Merge End
Advanced	2024-06-18	2024-07-01	2024-08-25	2024-07-21	2024-08-11	2024-08-25

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

Keep in mind the responsibility for violations of the Timeline.

[asyncapi-bot]

🎉 This issue has been resolved in version 2.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[aeworxet]

@Amzani
Please confirm the technical resolution of this Bounty Issue or delegate this action to other Maintainers.

[aeworxet]

Since @Amzani is vacationing

@Souvikns, @Shurtu-gal, can one of you please confirm the technical resolution of this Bounty Issue?

[Souvikns]

@aeworxet @AayushSaini101 has resolved this issue by merging #1476.

[aeworxet]

Bounty Issue Is Completed 🎉

@AayushSaini101, please go to the AsyncAPI page on Open Collective and submit an invoice for USD 400.00 with the expense title Bounty cli#337, tag bounty, and full URL of this Bounty Issue in the description.