mirror of
https://github.com/inventree/inventree-app.git
synced 2025-04-28 05:26:47 +00:00
Readme updates (#476)
* Update README.md - Add developer docs * Remove RELEASE.md
This commit is contained in:
parent
b02dc5bac7
commit
4ae28d60a1
41
README.md
41
README.md
@ -12,3 +12,44 @@ Written in the [Flutter](https://flutter.dev/) environment, the app provides nat
|
|||||||
## User Documentation
|
## User Documentation
|
||||||
|
|
||||||
User documentation for the InvenTree mobile app can be found [within the InvenTree documentation](https://inventree.readthedocs.io/en/latest/app/app/).
|
User documentation for the InvenTree mobile app can be found [within the InvenTree documentation](https://inventree.readthedocs.io/en/latest/app/app/).
|
||||||
|
|
||||||
|
## Developer Documentation
|
||||||
|
|
||||||
|
For developers looking to contribute to the project, we use Flutter for app development. The project has been tested in Android Studio (on both Windows and Mac) and also VSCode.
|
||||||
|
|
||||||
|
### Invoke Tasks
|
||||||
|
|
||||||
|
We use the [invoke](https://www.pyinvoke.org) to run some core tasks - you will need python and invoke installed on your local system.
|
||||||
|
|
||||||
|
### Getting Started
|
||||||
|
|
||||||
|
Initial project setup (after you have installed all required dev tools) is as follows:
|
||||||
|
|
||||||
|
Install required flutter packages:
|
||||||
|
```
|
||||||
|
flutter pub get
|
||||||
|
```
|
||||||
|
|
||||||
|
Generate initial translation files:
|
||||||
|
|
||||||
|
```
|
||||||
|
invoke translate
|
||||||
|
```
|
||||||
|
|
||||||
|
You should now be ready to debug on a connected or emulated device!
|
||||||
|
|
||||||
|
### Building Release Versions
|
||||||
|
|
||||||
|
Building release versions for target platforms (either android or iOS) is simplified using invoke:
|
||||||
|
|
||||||
|
Build Android release:
|
||||||
|
|
||||||
|
```
|
||||||
|
invoke android
|
||||||
|
```
|
||||||
|
|
||||||
|
Build iOS release:
|
||||||
|
|
||||||
|
```
|
||||||
|
invoke ios
|
||||||
|
```
|
47
RELEASE.md
47
RELEASE.md
@ -1,47 +0,0 @@
|
|||||||
# Release Process
|
|
||||||
|
|
||||||
## Android Play Store
|
|
||||||
|
|
||||||
[Reference](https://flutter.dev/docs/deployment/android#signing-the-app)
|
|
||||||
|
|
||||||
### Key File
|
|
||||||
|
|
||||||
Add a file `key.properties` under the android/ directory
|
|
||||||
|
|
||||||
### Increment Build Number
|
|
||||||
|
|
||||||
Make sure that the build number is incremented every time (or it will be rejected by Play Store).
|
|
||||||
|
|
||||||
### Copy Translations
|
|
||||||
|
|
||||||
Ensure that the translation files have been updated, and copied into the correct directory!!
|
|
||||||
|
|
||||||
```
|
|
||||||
cd lib/l10n
|
|
||||||
python collect_translations.py
|
|
||||||
```
|
|
||||||
|
|
||||||
### Build Appbundle
|
|
||||||
|
|
||||||
`flutter build appbundle`
|
|
||||||
|
|
||||||
### Upload Appbundle
|
|
||||||
|
|
||||||
Upload the appbundle file to the Android developer website.
|
|
||||||
|
|
||||||
## Apple Store
|
|
||||||
|
|
||||||
Ref: https://flutter.dev/docs/deployment/ios
|
|
||||||
|
|
||||||
### Build ipa
|
|
||||||
|
|
||||||
```
|
|
||||||
flutter clean
|
|
||||||
flutter build ipa --release --no-tree-shake-icons
|
|
||||||
```
|
|
||||||
|
|
||||||
### Validate and Distribute
|
|
||||||
|
|
||||||
- Open `./build/ios/archive/Runner.xcarchive` in Xcode
|
|
||||||
- Run "Validate App"
|
|
||||||
- Run "Distribute App"
|
|
Loading…
x
Reference in New Issue
Block a user