https://github.com/crequency/kitx-mobile

Mobile Client for KitX
https://github.com/crequency/kitx-mobile

android android-app android-application dart flutter flutter-apps ios ios-app kitx kitx-mobile

Last synced: 6 days ago
JSON representation

Mobile Client for KitX

• Host: GitHub
• URL: https://github.com/crequency/kitx-mobile
• Owner: Crequency
• License: agpl-3.0
• Created: 2022-08-18T03:34:07.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-09T18:10:16.000Z (2 months ago)
• Last Synced: 2024-09-09T22:23:33.237Z (2 months ago)
• Topics: android, android-app, android-application, dart, flutter, flutter-apps, ios, ios-app, kitx, kitx-mobile
• Language: Dart
• Homepage: https://github.com/Crequency/KitX
• Size: 4.64 MB
• Stars: 24
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/contributing.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# KitX Mobile

Mobile Client for KitX

Runs on `Android`, `iOS`

## Build project

> **Warning**

> Please use physical devices to debug, any emulator may cause problems.

> Android emulators are currently known to experience problems; the situation with iOS simulators is currently unknown.

1. Pass `flutter doctor -v`

2. `[China Mainland Developer]` Config flutter related SDKs mirror through commands:

   ```shell

   set PUB_HOSTED_URL=https://mirrors.tuna.tsinghua.edu.cn/dart-pub

   set FLUTTER_STORAGE_BASE_URL=https://mirrors.tuna.tsinghua.edu.cn/flutter

   ```

   > Only works in current session. Config system envrionment varieties for permanent effect.

3. Set system environment varieties `GRADLE_OPTS` to `-Dfile.encoding=UTF-8`.

4. Run `init_packages.sh/ps1` to fetch packages.

5. Use `flutter run` to run the project

   - `[Android]` You need connect your phone to your computer in `adb` first.

   - `[iOS]` Open your `simulator` first or connect your iPhone to your `XCode`.

6. `[Android]` Use `flutter build --split-per-abi` to build the project, remove `--split-per-abi` arguments for flat apk which is much bigger but support more platforms.

   - We suggest your to run `build.py` instead.

   - `[iOS]` Build app in `XCode`.

7. `[Android]` The output apk is in `/kitx_mobile/build/app/outputs/flutter-apk/` folder.

## Tools

- `update-version.py` for both `android` and `iOS`

  - This script changes version number in `pubspec.yaml`.

  - Run this script in `XCode` build phases by add custom script:

    ```shell

    cd ..

    python3 update-version.py

    ```

- `dependencies-analyzer.py`

  - This script analyze `pubspec.yaml` and update thirdparty data in both mobile and kitx docs.

  - Tow arguments:

    - `--export-for-mobile-about`

    - `--export-for-website-docs`