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

Adding Android Quickstart #2415

Merged
merged 16 commits into from
Oct 10, 2023
Merged

Adding Android Quickstart #2415

merged 16 commits into from
Oct 10, 2023

Conversation

vcampitelli
Copy link
Contributor

@vcampitelli vcampitelli commented Aug 8, 2023

There are some things that I wanted to check before we can actually merge this:

  • Decide on the name: should it actually be "Java for Android"?
  • I've named the sample repo as fusionauth-quickstart-android-java but the Quickstart instructions expects fusionauth-quickstart-LANGUAGE-FRAMEWORK-{api,web}, so maybe I should append -native? I didn't because it seems redundant.
  • The Issuer should match the instance URL, so the user should expose the instance with ngrok, update the Issuer and recreate asymmetric keys. Should I add these steps to the guide or create a simple script (probably add a command to the Node CLI) that does all that automatically?

@vcampitelli vcampitelli added the content Alert marketing to this change label Aug 8, 2023
@vcampitelli vcampitelli requested a review from mooreds August 8, 2023 12:47
@vcampitelli vcampitelli self-assigned this Aug 8, 2023
@mooreds
Copy link
Contributor

mooreds commented Aug 8, 2023

Decide on the name: should it actually be "Java for Android"?

How about "Android Java Quickstart"?

I've named the sample repo as fusionauth-quickstart-android-java but the Quickstart instructions expects fusionauth-quickstart-LANGUAGE-FRAMEWORK-{api,web}, so maybe I should append -native? I didn't because it seems redundant.

How about fusionauth-quickstart-java-android-native (or -mobile)? Either seem accurate.

The Issuer should match the instance URL, so the user should expose the instance with ngrok, update the Issuer and recreate asymmetric keys. Should I add these steps to the guide or create a simple script (probably add a command to the Node CLI) that does all that automatically?

Hmmm. Can you have this be a config setting, where you stand up FusionAuth with ngrok, update a settings file someplace, then build the android app?

@vcampitelli
Copy link
Contributor Author

How about "Android Java Quickstart"?

Done

How about fusionauth-quickstart-java-android-native (or -mobile)? Either seem accurate.

Done

Hmmm. Can you have this be a config setting, where you stand up FusionAuth with ngrok, update a settings file someplace, then build the android app?

What do you mean by "config setting"?

@mooreds
Copy link
Contributor

mooreds commented Aug 11, 2023

What do you mean by "config setting"?

When I am building an android app, is there a corresponding config file, similar to .env for docker or php, where a user could set up the ngrok URL?

So I'm talking about build time configuration, not runtime configuration.

Does that make sense?

@mooreds
Copy link
Contributor

mooreds commented Aug 11, 2023

@Aaron-Ritter @ColinFrick please determine who is the best person to review, tagged you both.

@vcampitelli
Copy link
Contributor Author

When I am building an android app, is there a corresponding config file, similar to .env for docker or php, where a user could set up the ngrok URL?

Yes, it does. That's why I asked if it would be better to write these steps to the quickstart (expose the instance with ngrok, update the Issuer, recreate asymmetric keys, update settings file) or create a simple script to do all that.

@mooreds
Copy link
Contributor

mooreds commented Aug 11, 2023

That's why I asked if it would be better to write these steps to the quickstart (expose the instance with ngrok, update the Issuer, recreate asymmetric keys, update settings file) or create a simple script to do all that.

Ah, okay. Since this won't be done typically (people will probably work through the quickstart once, not multiple times) I think documentation is fine.

@vcampitelli
Copy link
Contributor Author

  1. I've pushed an additional step on configuring issuer and regenerating JWT keys.
  2. I've also created a <IconButton> component to render UI-like buttons, like we had with markdown/asciidocs, and updated DocsDevREADME with instructions.
    icons
  3. As discussed with @mooreds, I didn't recreate the exact same Changebank theme as things aren't that easy with Android, but I used the same color, texts and functionality.

Copy link
Collaborator

@ColinFrick ColinFrick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After completing the tutorial the app didn't start. I had to remove following files first:

  • app/java/io/fusionauth/app/BrowserSelectionAdapter.java
  • app/res/layout/browser_selector_layout.xml
CleanShot 2023-09-06 at 09 19 06@2x

astro/src/content/quickstarts/quickstart-android-java.mdx Outdated Show resolved Hide resolved
astro/src/content/quickstarts/quickstart-android-java.mdx Outdated Show resolved Hide resolved
astro/src/content/quickstarts/quickstart-android-java.mdx Outdated Show resolved Hide resolved
astro/src/content/quickstarts/quickstart-android-java.mdx Outdated Show resolved Hide resolved
astro/src/content/quickstarts/quickstart-android-java.mdx Outdated Show resolved Hide resolved
@mooreds
Copy link
Contributor

mooreds commented Sep 11, 2023

@vcampitelli is this ready for @ColinFrick to re-review?

@vcampitelli
Copy link
Contributor Author

Yup, just pushed the kickstart file that was missing.

Can you please review it again @ColinFrick ?

Copy link
Collaborator

@ColinFrick ColinFrick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vcampitelli Quick start looks good. I have found a typo in the kickstart.json.

See FusionAuth/fusionauth-quickstart-java-android-native@8a38be2#r127101206

@vcampitelli
Copy link
Contributor Author

Done! Thanks @ColinFrick

@mooreds this is now ready for you to review

@vcampitelli vcampitelli requested review from mooreds and removed request for mooreds and Aaron-Ritter September 14, 2023 17:39
@mooreds mooreds merged commit 4f649b5 into master Oct 10, 2023
1 check passed
@mooreds mooreds deleted the feature/android-java-quickstart branch October 10, 2023 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Alert marketing to this change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants