|
1 | | -# Mobile App for BYR BBS |
2 | | -[bbs.byr.cn](https://bbs.byr.cn) |
3 | | - |
4 | | -[中文](README.md)|EN |
5 | | - |
6 | | -## Compile and Run |
7 | | -- Install [Flutter](https://flutter.dev/docs/get-started/), version 1.17.5 |
8 | | -- Configure Secrets |
9 | | - - Apply for *clientID*、*OAuth URL*、*identifier*, etc under [open api board](https://bbs.byr.cn/#!board/BBSOpenAPI) of BYR BBS |
10 | | - - Create a new repository of name *Secrets* with following project structure |
11 | | - ``` |
12 | | - lib/secrets.dart |
13 | | - pubspec.yaml |
14 | | - ``` |
15 | | - Save the following content in ```lib/secrets.dart```, fields start with ! should be acquired from BBS Admin mentioned above |
16 | | - ``` |
17 | | - class Secrets { |
18 | | - static const String clientID = !CLIENT ID |
19 | | - static const String appleID = APPLE ID |
20 | | - static const String bundleID = BUNDLE ID |
21 | | - static const String identifier = !IDENTIFIER |
22 | | - static const String welcomeSalt = !WELCOME SALT |
23 | | - static const String tokenDir = !OAUTH URL |
24 | | - static const String androidDevUpdateLink = ANDROID APP DEV UPDATE LINK |
25 | | - static const String androidStableUpdateLink = ANDROID APP STABLE UPDATE LINK |
26 | | - static const String androidVersionsLink = ANDROID VERSIONS LINK |
27 | | - } |
28 | | - ``` |
29 | | - - replace the following content in ```/pubspec.yaml``` of this repository with the URL of the repository from above step |
30 | | - ``` |
31 | | - secrets: |
32 | | - git: |
33 | | - url: ssh://[email protected]/BYR-App-Dev/secrets.git |
34 | | - ``` |
35 | | -- Run ```flutter pub get``` under the root of project to fetch dependencies |
36 | | -- Run application |
37 | | - - Debug ```flutter run --debug``` |
38 | | - - Release ```flutter run --release``` |
39 | | - - Build iOS ```./ios_build_cmd.sh``` |
40 | | - - Build Android ```./android_build_cmd.sh``` |
41 | | -
|
42 | | -## Project Structure |
43 | | -- [resources/](resources/) |
44 | | - - resources files |
45 | | -- [lib/](lib/) |
46 | | - - [configurations/](lib/configurations/) configurations of the app |
47 | | - - [customizations/](lib/customizations/) customizations, e.g. themes, languages |
48 | | - - [data_structures/](lib/data_structures/) internal data classes |
49 | | - - [helper/](lib/helper/) helper functions |
50 | | - - [local_objects/](lib/local_objects/) local data storage |
51 | | - - [networking/](lib/networking/) network requests |
52 | | - - [nforum/](lib/nforum/) NForum API related functions and data models |
53 | | - - [pages/](lib/pages/) page classes |
54 | | - - [reusable_components/](lib/reusable_components/) components used in pages |
55 | | - - [shared_objects/](lib/shared_objects/) shared objects in runtime |
56 | | - - [tasks/](lib/tasks/) tasks during startup |
57 | | - - [main.dart](lib/main.dart) entry of the app |
58 | | -
|
59 | | -## Open Source Library Credits |
60 | | -- [hive](https://pub.dev/packages/hive) |
61 | | -- [get](https://pub.dev/packages/get) |
62 | | -- [flutter_cache_manager](https://pub.dev/packages/flutter_cache_manager) |
63 | | -- [universal_platform](https://pub.dev/packages/universal_platform) |
64 | | -- [transparent_image](https://pub.dev/packages/transparent_image) |
65 | | -- [cached_network_image](https://pub.dev/packages/cached_network_image) |
66 | | -- [font_awesome_flutter](https://pub.dev/packages/font_awesome_flutter) |
67 | | -- [pull_to_refresh](https://pub.dev/packages/pull_to_refresh) |
68 | | -- [flutter_gifimage](https://pub.dev/packages/flutter_gifimage) |
69 | | -- [shimmer](https://pub.dev/packages/shimmer) |
70 | | -- [qr_flutter](https://pub.dev/packages/qr_flutter) |
71 | | -- [fast_gbk](https://pub.dev/packages/fast_gbk) |
72 | | -- [image_picker](https://pub.dev/packages/image_picker) |
73 | | -- [extended_text_field](https://pub.dev/packages/extended_text_field) |
74 | | -- [extended_image](https://pub.dev/packages/extended_image) |
75 | | -- [audioplayers](https://pub.dev/packages/audioplayers) |
76 | | -- [file_picker](https://pub.dev/packages/file_picker) |
77 | | -- [permission_handler](https://pub.dev/packages/permission_handler) |
78 | | -- [flutter_audio_recorder](https://pub.dev/packages/flutter_audio_recorder) |
79 | | -- [flutter_staggered_grid_view](https://pub.dev/packages/flutter_staggered_grid_view) |
80 | | -- [flutter_icons](https://pub.dev/packages/flutter_icons) |
81 | | -- [ota_update](https://pub.dev/packages/ota_update) |
82 | | -- [uni_links](https://pub.dev/packages/uni_links) |
83 | | -- [modal_bottom_sheet](https://pub.dev/packages/modal_bottom_sheet) |
84 | | -- [toast](https://pub.dev/packages/toast) |
85 | | -- [speech_recognition](https://pub.dev/packages/speech_recognition) |
86 | | -- [like_button](https://pub.dev/packages/like_button) |
87 | | -- [gallery_saver](https://pub.dev/packages/gallery_saver) |
88 | | -- [scroll_to_index](https://pub.dev/packages/scroll_to_index) |
89 | | -- [tinycolor](https://pub.dev/packages/tinycolor) |
90 | | -- [filesize](https://pub.dev/packages/filesize) |
91 | | -- [screenshot](https://pub.dev/packages/screenshot) |
92 | | -- [overlay_widget](https://takeroro.github.io/2019/07/28/Flutter-Overlay/) |
| 1 | +# Mobile App for BYR BBS |
| 2 | +[bbs.byr.cn](https://bbs.byr.cn) |
| 3 | + |
| 4 | +[中文](README.md)|EN |
| 5 | + |
| 6 | +## Compile and Run |
| 7 | +- Install [Flutter](https://flutter.dev/docs/get-started/), version ^2.2.0 |
| 8 | +- Configure Secrets |
| 9 | + - Apply for *clientID*、*OAuth URL*、*identifier*, etc under [open api board](https://bbs.byr.cn/#!board/BBSOpenAPI) of BYR BBS |
| 10 | + - Create a new repository of name *Secrets* with following project structure |
| 11 | + ``` |
| 12 | + lib/secrets.dart |
| 13 | + pubspec.yaml |
| 14 | + ``` |
| 15 | + Save the following content in ```lib/secrets.dart```, fields start with ! should be acquired from BBS Admin mentioned above |
| 16 | + ``` |
| 17 | + class Secrets { |
| 18 | + static const String clientID = !CLIENT ID |
| 19 | + static const String appleID = APPLE ID |
| 20 | + static const String bundleID = BUNDLE ID |
| 21 | + static const String identifier = !IDENTIFIER |
| 22 | + static const String welcomeSalt = !WELCOME SALT |
| 23 | + static const String tokenDir = !OAUTH URL |
| 24 | + static const String androidDevUpdateLink = ANDROID APP DEV UPDATE LINK |
| 25 | + static const String androidStableUpdateLink = ANDROID APP STABLE UPDATE LINK |
| 26 | + static const String androidVersionsLink = ANDROID VERSIONS LINK |
| 27 | + } |
| 28 | + ``` |
| 29 | + - replace the following content in ```/pubspec.yaml``` of this repository with the URL of the repository from above step |
| 30 | + ``` |
| 31 | + secrets: |
| 32 | + git: |
| 33 | + url: ssh://[email protected]/BYR-App-Dev/secrets.git |
| 34 | + ``` |
| 35 | +- Run ```flutter pub get``` under the root of project to fetch dependencies |
| 36 | +- Run application |
| 37 | + - Debug ```flutter run --debug``` |
| 38 | + - Release ```flutter run --release``` |
| 39 | + - Build iOS ```./ios_build_cmd.sh``` |
| 40 | + - Build Android ```./android_build_cmd.sh``` |
| 41 | +
|
| 42 | +## Project Structure |
| 43 | +- [resources/](resources/) |
| 44 | + - resources files |
| 45 | +- [lib/](lib/) |
| 46 | + - [configurations/](lib/configurations/) configurations of the app |
| 47 | + - [customizations/](lib/customizations/) customizations, e.g. themes, languages |
| 48 | + - [data_structures/](lib/data_structures/) internal data classes |
| 49 | + - [helper/](lib/helper/) helper functions |
| 50 | + - [local_objects/](lib/local_objects/) local data storage |
| 51 | + - [networking/](lib/networking/) network requests |
| 52 | + - [nforum/](lib/nforum/) NForum API related functions and data models |
| 53 | + - [pages/](lib/pages/) page classes |
| 54 | + - [reusable_components/](lib/reusable_components/) components used in pages |
| 55 | + - [shared_objects/](lib/shared_objects/) shared objects in runtime |
| 56 | + - [tasks/](lib/tasks/) tasks during startup |
| 57 | + - [main.dart](lib/main.dart) entry of the app |
| 58 | +
|
| 59 | +## Open Source Library Credits |
| 60 | +- [hive](https://pub.dev/packages/hive) |
| 61 | +- [get](https://pub.dev/packages/get) |
| 62 | +- [flutter_cache_manager](https://pub.dev/packages/flutter_cache_manager) |
| 63 | +- [universal_platform](https://pub.dev/packages/universal_platform) |
| 64 | +- [transparent_image](https://pub.dev/packages/transparent_image) |
| 65 | +- [cached_network_image](https://pub.dev/packages/cached_network_image) |
| 66 | +- [font_awesome_flutter](https://pub.dev/packages/font_awesome_flutter) |
| 67 | +- [pull_to_refresh](https://pub.dev/packages/pull_to_refresh) |
| 68 | +- [flutter_gifimage](https://pub.dev/packages/flutter_gifimage) |
| 69 | +- [shimmer](https://pub.dev/packages/shimmer) |
| 70 | +- [qr_flutter](https://pub.dev/packages/qr_flutter) |
| 71 | +- [fast_gbk](https://pub.dev/packages/fast_gbk) |
| 72 | +- [image_picker](https://pub.dev/packages/image_picker) |
| 73 | +- [extended_text_field](https://pub.dev/packages/extended_text_field) |
| 74 | +- [extended_image](https://pub.dev/packages/extended_image) |
| 75 | +- [audioplayers](https://pub.dev/packages/audioplayers) |
| 76 | +- [file_picker](https://pub.dev/packages/file_picker) |
| 77 | +- [permission_handler](https://pub.dev/packages/permission_handler) |
| 78 | +- [flutter_audio_recorder](https://pub.dev/packages/flutter_audio_recorder) |
| 79 | +- [flutter_staggered_grid_view](https://pub.dev/packages/flutter_staggered_grid_view) |
| 80 | +- [flutter_icons](https://pub.dev/packages/flutter_icons) |
| 81 | +- [ota_update](https://pub.dev/packages/ota_update) |
| 82 | +- [uni_links](https://pub.dev/packages/uni_links) |
| 83 | +- [modal_bottom_sheet](https://pub.dev/packages/modal_bottom_sheet) |
| 84 | +- [toast](https://pub.dev/packages/toast) |
| 85 | +- [speech_recognition](https://pub.dev/packages/speech_recognition) |
| 86 | +- [like_button](https://pub.dev/packages/like_button) |
| 87 | +- [gallery_saver](https://pub.dev/packages/gallery_saver) |
| 88 | +- [scroll_to_index](https://pub.dev/packages/scroll_to_index) |
| 89 | +- [tinycolor](https://pub.dev/packages/tinycolor) |
| 90 | +- [filesize](https://pub.dev/packages/filesize) |
| 91 | +- [screenshot](https://pub.dev/packages/screenshot) |
| 92 | +- [overlay_widget](https://takeroro.github.io/2019/07/28/Flutter-Overlay/) |
93 | 93 | - [pull_to_refresh_notification](https://pub.dev/packages/pull_to_refresh_notification) |
0 commit comments