X Tutup
Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (43 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 1.22 KB

OpenWebf Contributing Guide

  1. Prerequisites

    • Node.js v12.0 or later
    • Flutter version in the webf/pubspec.yaml
    • CMake v3.10.0 or later
    • Xcode (10.12) or later (Running on macOS or iOS)
    • Android NDK version 23.2.8568313 (Running on Android)

  2. Install

    $ npm install

  3. Building bridge

    Building bridge for all supported platform (macOS, linux, iOS, Android)

    $ npm run build:bridge:all

    Building bridge for one platform

    macOS

    $ npm run build:bridge:macos

    linux

    $ npm run build:bridge:linux

    iOS

    $ npm run build:bridge:ios

    Android

    For Windows users, make sure that running this command under MINGW64 environment(eg. Git Bash).

    $ npm run build:bridge:android

  4. Start example

    $ cd webf/example
$ flutter run

  5. Test (Unit Test and Integration Test)

    $ npm test
X Tutup