https://github.com/mdecker-mobilecomputing/ionic_tagebuch

Simple Ionic app for Android to demonstrate usage of capacitor plugin.
https://github.com/mdecker-mobilecomputing/ionic_tagebuch

capacitor ionic

Last synced: 6 days ago
JSON representation

Simple Ionic app for Android to demonstrate usage of capacitor plugin.

• Host: GitHub
• URL: https://github.com/mdecker-mobilecomputing/ionic_tagebuch
• Owner: MDecker-MobileComputing
• License: bsd-3-clause
• Created: 2021-04-22T20:12:16.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-04-27T20:22:50.000Z (over 3 years ago)
• Last Synced: 2024-11-09T22:41:13.303Z (2 months ago)
• Topics: capacitor, ionic
• Language: TypeScript
• Homepage:
• Size: 1.03 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Ionic app to demonstrate usage of a Capacitor plugin #

The repository contains an Ionic app for Android which is a very simple diary app.

All texts entered are written into a text file on the filesystem of the Android device,

for which the Capacitor plugin [filesystem](https://capacitorjs.com/docs/v3/apis/filesystem)

is used, see also [here](https://www.npmjs.com/package/@capacitor/filesystem).




----

## Screenshots ##

![Screenshot 1](screenshot_1.png)  ![Screenshot 2](screenshot_2.png)




----

## Adding the plugin ##

Update to capacitor 3.x if needed (see also [here](https://capacitorjs.com/docs/v3/updating/3-0)):

```

npm install @capacitor/cli@next @capacitor/core@next

```




Adding the plugin to the project:

```

npm install @capacitor/filesystem

npx cap sync

```




Get list of project's plugins:

```

npx cap ls android

```




----

## Entries needed in Manifest file of Android application ##

For using the plugin `filesystem` in the app the following things in the [Manifest file](android/app/src/main/AndroidManifest.xml) have to be changed:

Allowing access to folder `Documents` as of Android 10:

```

android:requestLegacyExternalStorage="true"

```

Declaring permission:

```

```




----

## Text editor app ##

The following app can be used to open the text file created by this app: 

https://f-droid.org/de/packages/org.billthefarmer.editor/




----

## Using Live Reload ##

Ensure that NPM module [native-run](https://www.npmjs.com/package/native-run) is installed globally.

If it is not installed, then you can install it using the following command:

```

npm install -g @ionic/cli native-run

```




For using *Live Reload* you then have to call the following command (*Android Studio* should be running but no project opened when entering this command):

```

ionic cap run android -l --external

```

At startup of this command you will have to select a local IP address.

After this the project will be opened in *Android Studio*.

Start the app in the emulator by clicking on the "Run" button in *Android Studio*.




When you now save a changed file of the Ionic application, then the app in the emulator will be refreshed and uses the changed file(s) afterwards.




----

## License ##

See the [LICENSE file](LICENSE.md) for license rights and limitations (BSD 3-Clause License) for the files in this repository.