xevion/paperless-mobile
1
0
Fork 0
mirror of https://github.com/Xevion/paperless-mobile.git synced 2025-12-06 07:15:43 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update build instructions

Browse Source
This commit is contained in:
Anton Stubenbord
2023-02-14 23:46:56 +01:00
parent 31d2a9ec01
commit 8a0e633baf
2 changed files with 9 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -75,22 +75,17 @@ To get a local copy up and running follow these simple steps.
### Prerequisites ### Prerequisites
* Install an IDE of your choice (e.g. VSCode with the Dart/Flutter extensions) * Install an IDE of your choice (e.g. VSCode with the Dart/Flutter extensions)
* Install the flutter SDK (https://docs.flutter.dev/get-started/install) _or_ use the flutter git submodule pinned in this project by running `git submodule update --init` inside the project root directory.
*
### Install dependencies and generate files ### Install dependencies and generate files
1. First, clone the repository: 1. First, clone the repository:
```sh ```sh
git clone https://github.com/astubenbord/paperless-mobile.git git clone https://github.com/astubenbord/paperless-mobile.git
``` ```
In this project, flutter is pinned at a specific version as a git submodule to ensure all contributors work with the same environment and build with the same flutter version. You can also use your local flutter installation, just make sure that the app also compiles with the same flutter version as pinned in the `flutter` submodule when opening a pull request.
To download the pinned flutter SDK from the submodule and plan to install the dependencies manually in the next step, simply run You can now run the `scripts/install_dependencies.sh` script at the root of the project, which will automatically install dependencies and generate files for both the app and local packages.
```sh
git submodule update --init
```
You can now run the `scripts/install_dependencies.sh` script at the root of the project, which will automatically install dependencies and generate files for both the app and subpackages. Note that the `install_dependencies.sh` script will pull the flutter submodule and use the SDK to execute the flutter commands. If you want to manually install dependencies and build generated files, you can also run the following commands:
If you don't want to use submodules, you can also run the following commands using your local flutter installation:
#### Inside the `packages/paperless_api/` folder: #### Inside the `packages/paperless_api/` folder:
2. Install the dependencies for `paperless_api` 2. Install the dependencies for `paperless_api`

10
scripts/install_dependencies.sh
View File

@@ -3,9 +3,9 @@
git submodules update --init git submodules update --init
pushd ../ pushd ../
pushd packages/paperless_api pushd packages/paperless_api
../../flutter/bin/flutter pub get flutter pub get
../../flutter/bin/flutter pub run build_runner build --delete-conflicting-outputs flutter pub run build_runner build --delete-conflicting-outputs
popd popd
flutter/bin/flutter pub get flutter pub get
flutter/bin/flutter pub run build_runner build --delete-conflicting-outputs flutter pub run build_runner build --delete-conflicting-outputs
flutter/bin/flutter pub run intl_utils:generate flutter pub run intl_utils:generate