Skip to content

Add detailed instructions for running the Cordova app locally in development mode #14

@SergiyIva

Description

@SergiyIva

Issue Description

The current README provides a high-level overview of setting up the demo application and preparing it for integration. However, Step 1 lacks sufficient details on how to run the Cordova application locally in development mode. Specifically, there is no guidance on:

  • Launching the app on an Android emulator or physical device with live/hot-reload enabled.
  • Enabling automatic browser platform syncing or file watching for rapid UI iteration.
  • Recommended workflows for frontend development (e.g., using cordova run android --livereload, port configuration, etc.).
  • Any required configuration flags, environment variables, or additional plugins needed for a smooth dev experience.

This makes it difficult for new contributors or integrators to start active development quickly.

Requested Improvement

Please expand the README (preferably in Step 1 or a dedicated "Local Development Setup" section) with clear, step-by-step instructions on:

  1. Running with live-reload:

    cordova run android --livereload -- --port=8000

    Include explanations of flags, default ports, and how to access the dev server.

  2. Enabling browser platform for faster iteration (optional but useful):

    cordova platform add browser
    cordova run browser -- --livereload
  3. Debugging setup:

    • How to use chrome://inspect for Android.
    • Recommended IDLE debug configurations (if applicable).
  4. Common pitfalls:

    • Whitelisting the livereload server in config.xml (<allow-navigation href="http://localhost:8000" />).
    • Ensuring cordova-plugin-whitelist is installed.
  5. Example workflow for a typical edit → reload cycle.

Why This Matters

Clear local dev instructions lower the barrier to entry, improve contributor experience, and align with modern Cordova/Ionic development practices.

Thank you for maintaining this demo! 🙌

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions