README-EN.md

Mobile App for BYR BBS

bbs.byr.cn

中文|EN

Compile and Run

• Install Flutter, version ^2.2.0
• Configure Secrets
  • Apply for clientID、OAuth URL、identifier, etc under open api board of BYR BBS
  • Create a new repository of name Secrets with following project structure

    lib/secrets.dart
    pubspec.yaml
    

    Save the following content in lib/secrets.dart, fields start with ! should be acquired from BBS Admin mentioned above

    class Secrets {
        static const String clientID = !CLIENT ID
        static const String appleID = APPLE ID
        static const String bundleID = BUNDLE ID
        static const String identifier = !IDENTIFIER
        static const String welcomeSalt = !WELCOME SALT
        static const String tokenDir = !OAUTH URL
        static const String androidDevUpdateLink = ANDROID APP DEV UPDATE LINK
        static const String androidStableUpdateLink = ANDROID APP STABLE UPDATE LINK
        static const String androidVersionsLink = ANDROID VERSIONS LINK
    }
    

  • replace the following content in /pubspec.yaml of this repository with the URL of the repository from above step

    secrets:
    git:
        url: ssh://git@github.com/BYR-App-Dev/secrets.git
    

• Run flutter pub get under the root of project to fetch dependencies
• Run application
  • Debug flutter run --debug
  • Release flutter run --release
  • Build iOS ./ios_build_cmd.sh
  • Build Android ./android_build_cmd.sh

Project Structure

• resources/
  • resources files
• lib/
  • configurations/ configurations of the app
  • customizations/ customizations, e.g. themes, languages
  • data_structures/ internal data classes
  • helper/ helper functions
  • local_objects/ local data storage
  • networking/ network requests
  • nforum/ NForum API related functions and data models
  • pages/ page classes
  • reusable_components/ components used in pages
  • shared_objects/ shared objects in runtime
  • tasks/ tasks during startup
  • main.dart entry of the app

Open Source Library Credits

• hive
• get
• flutter_cache_manager
• universal_platform
• transparent_image
• cached_network_image
• font_awesome_flutter
• pull_to_refresh
• flutter_gifimage
• shimmer
• qr_flutter
• fast_gbk
• image_picker
• extended_text_field
• extended_image
• audioplayers
• file_picker
• permission_handler
• flutter_audio_recorder
• flutter_staggered_grid_view
• flutter_icons
• ota_update
• uni_links
• modal_bottom_sheet
• toast
• speech_recognition
• like_button
• gallery_saver
• scroll_to_index
• tinycolor
• filesize
• screenshot
• overlay_widget
• pull_to_refresh_notification