Giter VIP home page Giter VIP logo

ui-cordova's Introduction

ManyWho UI Cordova

Cordova container for running ManyWho flows as apps on mobile devices.

Prerequisites

  • NodeJS
  • Cordova
  • Xcode for iOS apps
  • Android Studio / SDK for android apps

If you are unfamiliar with cordova and / or building mobile apps you should go through the really good cordova tutorial: https://cordova.apache.org/docs/en/latest/guide/cli/index.html

If you can get a cordova app running on an iOS or Android device / emulator then you are ready to go.

Building

Make sure your flow is published before running the build.

npm install
npm run build

This will download the latest version of the UI assets and update index.html with the specified tenant id, flow id and flow version id.

If you choose to run the flow offline you will also be promted for a username and password.

The build command optionally accepts two arguments:

cdnBaseUrl [default - https://assets.manywho.com]
apiBaseUrl [default - https://flow.manywho.com]

example

npm run build -- --apiBaseUrl="https://example.com" --cdnBaseUrl="https://example.com"

Alternatively, to use local dependencies:

  • Install the dependencies for each ui-* project (consult their respective readme's for details)
  • Run the watcher or a static build for each ui-* project, such that the --build switch points to the www directory in this project

Running

Run using the standard cordova command line e.g.

cordova prepare android
cordova run android

cordova prepare ios
cordova run ios

The browersync plugin is included which will auto reload the app when changes to the assets are made, append -- --live-reload to enable this.

More details on available commands can be found here

Contributing

Contributions are welcome to the project - whether they are feature requests, improvements or bug fixes! Refer to CONTRIBUTING.md for our contribution requirements.

License

ui-cordova is released under our shared source license: https://manywho.com/sharedsource

ui-cordova's People

Contributors

steve-manywho avatar dshoulders avatar matt-manywho avatar

Watchers

James Cloos avatar Jose Collazzi avatar Nathan avatar  avatar William Eccles avatar  avatar Jonjo avatar Joao Moreira avatar  avatar William Eccles avatar Rick Timmis avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.