Skip to content

Commit 4743a5e

Browse files
geavenxvdonnangelo
andauthored
v1.0.4
* add LICENSE file fix #12 * rename sdk library from authfy-sdk-2.5.4 to authcube-sdk-2.5.4 * update README.md with build & run instructions fix #11 * fix image layouts --------- Co-authored-by: Vitor Cardoso <vitor.cardoso@sec4you.com.br>
1 parent 048e8fc commit 4743a5e

File tree

7 files changed

+89
-4
lines changed

7 files changed

+89
-4
lines changed

LICENSE

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
IT4YOU CONSULTORIA EM INFORMATICA LTDA Proprietary Software License Agreement.
2+
3+
COPYRIGHTS (c) SINCE 2009, IT4YOU CONSULTORIA EM INFORMATICA LTDA.
4+
5+
This software is proprietary and confidential. All rights reserved.
6+
Unauthorized copying of this file, via any medium, is strictly prohibited.
7+
Distribution, modification, or use of this software in source or binary forms is not allowed
8+
without explicit permission from IT4YOU CONSULTORIA EM INFORMATICA LTDA.

README.md

Lines changed: 81 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,82 @@
1-
# authfy-sample-android
2-
Authfy Native Sample App for Android
1+
# 1. Introduction
2+
This sample app lets you quickly test the integration of Authcube's Android SDK.
3+
4+
## License
5+
This software is proprietary and protected under IT4YOU CONSULTORIA EM INFORMATICA LTDA's license.
6+
All rights reserved since 2009.
7+
8+
Please refer to the LICENSE file in the repository for complete terms.
9+
10+
# 2. Running the app
11+
12+
### Prerequisites
13+
14+
Make sure you have installed:
15+
- Git
16+
- [Android Studio](https://developer.android.com/studio)
17+
18+
### Step 1: Clone this Repository
19+
Run the following command in your terminal:
20+
21+
```bash
22+
git clone https://github.com/authcube/sample-app-android.git
23+
```
24+
25+
### Step 2: Open the Project
26+
1. Open Android Studio
27+
2. Click **"Open"** on the welcome screen (or go to **File > Open...** in the top menu)
28+
3. Navigate to the directory where you cloned the project
29+
4. Wait for the project to load (you'll see a progress bar at the bottom saying "Gradle Build Running")
30+
31+
### Step 3: Set Up and Configure the Emulator
32+
1. Click on "Tools" in the top menu
33+
2. Click "Device Manager"
34+
3. Click the "Add a new device" button and "Create a new device"
35+
4. In the "Phone" category, select Pixel 6 (or the any other phone)
36+
5. Click "Next"
37+
6. Select "API 34" (Android 14.0)
38+
- If it's not installed, click **install**
39+
![](docs/images/api-version.png)
40+
7. Finish the virtual device setup
41+
42+
### Step 4: Run the App
43+
1. Select your newly created device in the top bar
44+
2. Hit the `Run 'app'` button (or press **Shift + f10**)
45+
![](docs/images/run.png)
46+
47+
# 3. Using the app
48+
Before logging in, you **MUST** configure the app with identity provider details:
49+
1. Click **Settings**
50+
51+
![](docs/images/app-settings.png)
52+
53+
2. Fill in the fields with **your** information
54+
55+
![](docs/images/save-config.png)
56+
57+
3. Go back and log in. You'll be redirected to the **home screen**
58+
59+
## Troubleshooting
60+
### If the build fails
61+
Try these fixes in order:
62+
1. Click **File > Sync Project with Gradle Files**
63+
2. Click **Build > Clean Project** then **Build > Rebuild Project**
64+
3. Close Android Studio and reopen it
65+
66+
### Additional help
67+
- Make sure Android Studio is fully updated:
68+
1. Click **"Help"** in the top menu
69+
2. Click **"Check for updates"**
70+
3. Install any available updates
71+
72+
- If nothing else works, try:
73+
1. Close Android Studio
74+
2. Delete the .gradle/ directory from your project
75+
3. Reopen Android Studio and click the `Run 'app'` button
76+
4. Let it rebuild the app
77+
78+
### Important Information
79+
The Android Emulator is not aware of your local HOSTS configuration, so it is advised to use an
80+
external server to develop and test your app
81+
382

4-
## Important Information
5-
The Android Emulator is not aware of your local HOSTS configuration, so it is advised to use an external server to develop and test your app

docs/images/api-version.png

124 KB
Loading

docs/images/app-settings.png

62.7 KB
Loading

docs/images/run.png

91.4 KB
Loading

docs/images/save-config.png

90.8 KB
Loading

0 commit comments

Comments
 (0)