Readme
This commit is contained in:
parent
45e5e3269c
commit
a2d47ca5d9
18
README.md
18
README.md
|
|
@ -29,6 +29,11 @@ Note: the mobile app requires the latest version of the web app.
|
|||
- [x] Tablet support
|
||||
- [ ] Web/Version 2
|
||||
|
||||
## Setting up the app
|
||||
- Run `cp lib/.env.dart.example lib/.env.dart` to create the config file.
|
||||
- Run `cp android/app/build.gradle.dev android/app/build.gradle` to support running the code unsigned.
|
||||
- Run `flutter run` while you have a device connected to the computer or an emulator running and now you can run it.
|
||||
|
||||
## Application Architecture
|
||||
|
||||
The application was created using the [Flutter Redux Starter](https://github.com/hillelcoren/flutter-redux-starter).
|
||||
|
|
@ -45,20 +50,13 @@ The architecture is based off these two projects:
|
|||
- [Architectural review](https://hillelcoren.com/2018/08/10/an-architectural-review-of-the-invoice-ninja-flutter-app/)
|
||||
- [Additional thoughts](https://hillelcoren.com/2018/08/24/ongoing-adventures-with-flutter-and-redux/)
|
||||
|
||||
## Setting up the app
|
||||
- Run `cp lib/.env.dart.example lib/.env.dart` to create the config file.
|
||||
- Run `cp android/app/build.gradle.dev android/app/build.gradle` to support running the code unsigned.
|
||||
- Run `flutter run` while you have a device connected to the computer or an emulator running and now you can run it.
|
||||
|
||||
## Developer Notes
|
||||
|
||||
### Code generation
|
||||
## Code generation
|
||||
- Run `flutter packages pub run build_runner build --delete-conflicting-outputs` to regenerate the model files. It will also remove the old generated files so conflicts are avoided..
|
||||
|
||||
### Tests
|
||||
## Tests
|
||||
- Run `flutter drive --target=test_driver/all_it.dart` to run the tests
|
||||
|
||||
### Code Signing
|
||||
## Code Signing
|
||||
- Run `cp android/app/build.gradle.prod android/app/build.gradle` to support running the code signed
|
||||
- Run `cp android/key.properties.example android/key.properties` to create the keys file
|
||||
- Run `keytool -genkey -v -keystore key.jks -keyalg RSA -keysize 2048 -validity 10000 -alias invoiceninja` to generate a key to be able to sign the android application.
|
||||
|
|
|
|||
Loading…
Reference in New Issue