Skip to content

Commit 79b8629

Browse files
OS-pedrogustavobilroalexgerardojacinto
OS-pedrogustavobilro
and
alexgerardojacinto
authored
chore: Add example app (#2)
* refactor: Move plugin to specific sub-folder To have similar structure to new unified repositories References: - https://github.com/ionic-team/capacitor-filesystem - https://outsystemsrd.atlassian.net/browse/RMET-4491 * chore: Add a few files to root folder * docs: Add contributing info * chore: Add .npmrc to correct directory * chore: Add license to plugin folder * chore: Update GitHub links * ci: Add config file for semantic-release * chore: Add templates for issues and PRs * ci: Add Github actions Based off of newer capacitor plugin repositories * docs: Add root README * chore: Add semantic-release to package.json * chore: Change plugin version to expected standard Our semantic-release config expects -next for versions going to npm next tag. * chore: remove header from changelog Because it is not recognized by semantic-release * chore: Add example app using ionic cli * chore: fix dependencies Unused dependencies removed. Capacitor framework set to Cap 8 alpha. Haptics set to local folder in this repo. * chore: Add android and ios to example-app * refactor: Move plugin source back to root This allows to re-use the plugin easily as a Swift / Pods Package directly, which wasn't possible when the plugin was in a monorepo. References: https://outsystems.slack.com/archives/C06EJRL6ZGT/p1758199095926609 * chore: Add missing `src` folder * refactor: Move example app folder * chore: remove unused logo asset * chore: Add UI for example app Copied from capacitor-testapp * docs: Add small readme about example app * ci: Build example app for PRs * chore: ignore example app from lint * chore: update ignore folders for lint * chore: Update example-app/README.md Co-authored-by: Alexandre Jacinto <alexandre.jacinto@outsystems.com> --------- Co-authored-by: Alexandre Jacinto <alexandre.jacinto@outsystems.com>
1 parent ce26af6 commit 79b8629

102 files changed

Lines changed: 14085 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.eslintignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
build
2+
.build
23
dist
4+
example-app

‎.github/workflows/continuous_integration.yml‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,32 @@ jobs:
3636
- name: 'Setup Tools'
3737
uses: ./.github/actions/setup-tools
3838
- name: 'Verify iOS'
39-
run: npm run verify:ios
39+
run: npm run verify:ios
40+
41+
build-example-app-android:
42+
needs: ['verify-plugin-ios', 'verify-plugin-android']
43+
runs-on: 'macos-15'
44+
timeout-minutes: 30
45+
steps:
46+
- uses: actions/checkout@v4
47+
- name: 'Setup Tools'
48+
uses: ./.github/actions/setup-tools
49+
- name: 'Prepare example app'
50+
uses: ./.github/actions/prepare-example-app
51+
- name: 'Build Android example app'
52+
working-directory: ./example-app/android
53+
run: ./gradlew clean assembleDebug
54+
55+
build-example-app-ios:
56+
needs: ['verify-plugin-ios', 'verify-plugin-android']
57+
runs-on: 'macos-15'
58+
timeout-minutes: 30
59+
steps:
60+
- uses: actions/checkout@v4
61+
- name: 'Setup Tools'
62+
uses: ./.github/actions/setup-tools
63+
- name: 'Prepare example app'
64+
uses: ./.github/actions/prepare-example-app
65+
- name: 'Build iOS example app'
66+
working-directory: ./example-app/ios/App
67+
run: xcodebuild clean build -workspace App.xcworkspace -scheme App CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO

‎.prettierignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
build
2+
.build
23
dist
4+
example-app

‎example-app/.browserslistrc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Chrome >=79
2+
ChromeAndroid >=79
3+
Firefox >=70
4+
Edge >=79
5+
Safari >=14
6+
iOS >=14

‎example-app/.gitignore‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
8+
# testing
9+
/coverage
10+
11+
# production
12+
/dist
13+
14+
# misc
15+
.DS_Store
16+
.env.local
17+
.env.development.local
18+
.env.test.local
19+
.env.production.local
20+
/.nx
21+
/.nx/cache
22+
/.vscode/*
23+
!/.vscode/extensions.json
24+
.idea
25+
26+
npm-debug.log*
27+
yarn-debug.log*
28+
yarn-error.log*
29+
30+
# Optional eslint cache
31+
.eslintcache

‎example-app/.vscode/extensions.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"recommendations": [
3+
"Webnative.webnative"
4+
]
5+
}

‎example-app/README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Example app
2+
3+
This example app is used to develop and test new features and verify bug fixes for the Capacitor Haptics plugin, present at the root of this repository.
4+
5+
It is built with [Ionic React](https://ionicframework.com/react). You should have [Ionic cli installed](https://ionicframework.com/docs/intro/cli).
6+
7+
## Testing
8+
9+
To setup the app
10+
11+
```bash
12+
npm install
13+
ionic build
14+
ionic cap sync
15+
```
16+
17+
Then, to run the app natively, you can open Android Studio / Xcode via `ionic cap open [android/ios]` or do `ionic cap run [android/ios]` to generate and deploy a new build.
18+
19+
To run just the web app, run `ionic serve`.

‎example-app/android/.gitignore‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Using Android gitignore template: https://github.com/github/gitignore/blob/HEAD/Android.gitignore
2+
3+
# Built application files
4+
*.apk
5+
*.aar
6+
*.ap_
7+
*.aab
8+
9+
# Files for the ART/Dalvik VM
10+
*.dex
11+
12+
# Java class files
13+
*.class
14+
15+
# Generated files
16+
bin/
17+
gen/
18+
out/
19+
# Uncomment the following line in case you need and you don't have the release build type files in your app
20+
# release/
21+
22+
# Gradle files
23+
.gradle/
24+
build/
25+
26+
# Local configuration file (sdk path, etc)
27+
local.properties
28+
29+
# Proguard folder generated by Eclipse
30+
proguard/
31+
32+
# Log Files
33+
*.log
34+
35+
# Android Studio Navigation editor temp files
36+
.navigation/
37+
38+
# Android Studio captures folder
39+
captures/
40+
41+
# IntelliJ
42+
*.iml
43+
.idea/workspace.xml
44+
.idea/tasks.xml
45+
.idea/gradle.xml
46+
.idea/assetWizardSettings.xml
47+
.idea/dictionaries
48+
.idea/libraries
49+
# Android Studio 3 in .gitignore file.
50+
.idea/caches
51+
.idea/modules.xml
52+
# Comment next line if keeping position of elements in Navigation Editor is relevant for you
53+
.idea/navEditor.xml
54+
55+
# Keystore files
56+
# Uncomment the following lines if you do not want to check your keystore files in.
57+
#*.jks
58+
#*.keystore
59+
60+
# External native build folder generated in Android Studio 2.2 and later
61+
.externalNativeBuild
62+
.cxx/
63+
64+
# Google Services (e.g. APIs or Firebase)
65+
# google-services.json
66+
67+
# Freeline
68+
freeline.py
69+
freeline/
70+
freeline_project_description.json
71+
72+
# fastlane
73+
fastlane/report.xml
74+
fastlane/Preview.html
75+
fastlane/screenshots
76+
fastlane/test_output
77+
fastlane/readme.md
78+
79+
# Version control
80+
vcs.xml
81+
82+
# lint
83+
lint/intermediates/
84+
lint/generated/
85+
lint/outputs/
86+
lint/tmp/
87+
# lint/reports/
88+
89+
# Android Profiling
90+
*.hprof
91+
92+
# Cordova plugins for Capacitor
93+
capacitor-cordova-android-plugins
94+
95+
# Copied web assets
96+
app/src/main/assets/public
97+
98+
# Generated Config files
99+
app/src/main/assets/capacitor.config.json
100+
app/src/main/assets/capacitor.plugins.json
101+
app/src/main/res/xml/config.xml

‎example-app/android/app/.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/build/*
2+
!/build/.npmkeep

‎example-app/android/app/build.gradle‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
apply plugin: 'com.android.application'
2+
3+
android {
4+
namespace "io.ionic.starter"
5+
compileSdk rootProject.ext.compileSdkVersion
6+
defaultConfig {
7+
applicationId "io.ionic.starter"
8+
minSdkVersion rootProject.ext.minSdkVersion
9+
targetSdkVersion rootProject.ext.targetSdkVersion
10+
versionCode 1
11+
versionName "1.0"
12+
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
13+
aaptOptions {
14+
// Files and dirs to omit from the packaged assets dir, modified to accommodate modern web apps.
15+
// Default: https://android.googlesource.com/platform/frameworks/base/+/282e181b58cf72b6ca770dc7ca5f91f135444502/tools/aapt/AaptAssets.cpp#61
16+
ignoreAssetsPattern '!.svn:!.git:!.ds_store:!*.scc:.*:!CVS:!thumbs.db:!picasa.ini:!*~'
17+
}
18+
}
19+
buildTypes {
20+
release {
21+
minifyEnabled false
22+
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
23+
}
24+
}
25+
}
26+
27+
repositories {
28+
flatDir{
29+
dirs '../capacitor-cordova-android-plugins/src/main/libs', 'libs'
30+
}
31+
}
32+
33+
dependencies {
34+
implementation fileTree(include: ['*.jar'], dir: 'libs')
35+
implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
36+
implementation "androidx.coordinatorlayout:coordinatorlayout:$androidxCoordinatorLayoutVersion"
37+
implementation "androidx.core:core-splashscreen:$coreSplashScreenVersion"
38+
implementation project(':capacitor-android')
39+
testImplementation "junit:junit:$junitVersion"
40+
androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
41+
androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
42+
implementation project(':capacitor-cordova-android-plugins')
43+
}
44+
45+
apply from: 'capacitor.build.gradle'
46+
47+
try {
48+
def servicesJSON = file('google-services.json')
49+
if (servicesJSON.text) {
50+
apply plugin: 'com.google.gms.google-services'
51+
}
52+
} catch(Exception e) {
53+
logger.info("google-services.json not found, google-services plugin not applied. Push Notifications won't work")
54+
}

0 commit comments

Comments
 (0)