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.

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

"My Second Quarkus Application" guide #31618

Closed
holly-cummins opened this issue Mar 6, 2023 · 5 comments · Fixed by #34401
Closed

"My Second Quarkus Application" guide #31618

holly-cummins opened this issue Mar 6, 2023 · 5 comments · Fixed by #34401
Labels
Milestone

Comments

@holly-cummins
Copy link
Contributor

Description

We have "My first application" which is hello world, but there is a gap for a "My second application" guide. I had to prep a client demo today, and I found myself doing steps I think I've done a few times before, but not written down before. I needed something less trivial than https://quarkus.io/guides/getting-started, but more trivial than https://quarkus.io/guides/hibernate-orm-panache. This guide would be useful as a simple demo script and also for users who want to a written tutorial which showcases dev services.

What we want is something that allows users to experience the magic of "look, you're using postgres, but you didn't configure postgres .... amazing!"

Existing documentation about dev services is more of a reference, and assumes quite a lot of knowledge about them. https://quarkus.io/guides/rest-data-panache showcases nice set of capability but it doesn't have any dev services content (which is sensible, since it's a guide about panache, not dev services). It also has a lot of 'new' code a user has to write, which is good as a rich reference, but for a quick tutorial/demo may be a bit too slow.

See discussion here https://quarkusio.zulipchat.com/#narrow/stream/187038-dev/topic/.22My.20second.20application.22.20guide/near/339431983

Implementation ideas

I have a skeleton set of instructions that I could polish up and then either collaborate with someone on the docs team to make comprehensible, or polish up fully myself.

In the end I used code.quarkus.io to make an app with postgres, resteasy reactive, and panache. Then I added a few lines so that my rest endpoint would return my entity. The ideal was something where I didn't need to download any external code, and I could type my code changes without templates or copy and pasting.

@quarkus-bot
Copy link

quarkus-bot bot commented Mar 6, 2023

You added a link to a Zulip discussion, please make sure the description of the issue is comprehensive and doesn't require accessing Zulip

This message is automatically generated by a bot.

@ingmarfjolla
Copy link

i'd like to help with something like this! I think something similar for extension writing would be very helpful as well

@holly-cummins
Copy link
Contributor Author

Thanks, @ingmarfjolla! I've just created #34401 as a skeleton, and would welcome your suggestions!

@quarkus-bot quarkus-bot bot added this to the 3.3 - main milestone Jul 25, 2023
@holly-cummins
Copy link
Contributor Author

The ink is barely dry on the merge, and I already need to refer to this guide. :)

@holly-cummins
Copy link
Contributor Author

For anyone who finds this issue, the guide is now live: https://quarkus.io/version/main/guides/getting-started-dev-services

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants