mirror of
https://github.com/inventree/inventree-app.git
synced 2025-04-28 05:26:47 +00:00
72 lines
2.3 KiB
Markdown
72 lines
2.3 KiB
Markdown
# InvenTree Mobile App
|
|
|
|
[](https://opensource.org/licenses/MIT)
|
|
|
|
|
|
[](https://coveralls.io/github/inventree/inventree-app?branch=master)
|
|
|
|
The InvenTree mobile / tablet application is a companion app for the [InvenTree stock management system](https://github.com/inventree/InvenTree).
|
|
|
|
Written in the [Flutter](https://flutter.dev/) environment, the app provides native support for Android and iOS devices.
|
|
|
|
## Installation
|
|
|
|
You can install the app via the following channels:
|
|
|
|
### Google Play Store (Android)
|
|
|
|
Download and install from the [Google Play Store](https://play.google.com/store/apps/details?id=inventree.inventree_app&hl=en_AU)
|
|
|
|
### Apple Store (iOS)
|
|
|
|
Download and install from the [Apple App Store](https://apps.apple.com/au/app/inventree/id1581731101)
|
|
|
|
### Direct Download (Android)
|
|
|
|
We provide direct downloads for Android users - view our [download page via polar.sh](https://polar.sh/inventree/products/299bf0d5-af88-4e0f-becf-c007ad37ecf2)
|
|
|
|
## User Documentation
|
|
|
|
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:
|
|
|
|
Generate initial translation files:
|
|
|
|
```
|
|
invoke translate
|
|
```
|
|
|
|
Install required flutter packages:
|
|
```
|
|
flutter pub get
|
|
```
|
|
|
|
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
|
|
```
|