vigour-plugin

Example of a vigour-style native plugin. Make new plugins by forking this repo.

Usage no npm install needed!

<script type="module">
  import vigourPlugin from 'https://cdn.skypack.dev/vigour-plugin';
</script>

README

plugin

Fork this repo to make vigour-wrapper plugins.

Creating plugins from this skeleton

  • Fork this repository
  • Choose a name (<plugin-name>) for your new plugin
  • In this README
    • Use <plugin-name>
      • for the title
      • in the install section
    • Change the description
    • Remove this section
  • In package.json

    • Use <plugin-name> in the following fields

      • name
      • repository.url
      • bugs.url
      • homepage
      • vigour.plugin.android.className
      • vigour.plugin.android.instantiation
      • vigour.native.platforms.ios.productName
      • vigour.native.platforms.ios.organizationIdentifier
      • vigour.native.platforms.android.productName
      • vigour.native.platforms.android.applicationId

    • Update the following fields

      • description
      • keywords
      • author
      • contributors
  • In the native directory
    • Rename native/android/plugin
    • Update values in native/android/<plugin-name>/lib/build.gradle
    • Change the package names in the android source
    • Change the package in the libs AndroidManifest.xml
    • Create lib functionality and make the android example work
    • publish the android lib to jcenter, see instructions

Install

  • npm i vigour-plugin

Updates via upstream remote

  • git remote add skeleton git@github.com:vigour-io/plugin.git
  • git pull skeleton develop

Try it out

  • npm run ios
  • npm run android
  • npm run all

Usage

See tests

Building native apps

See wrapper