Go to file
Hillel Coren 6b09cee4df Dashboard overview 2022-08-14 17:02:00 +03:00
.github/workflows Update build 2022-08-07 09:08:10 +03:00
android Revert changes to Android minSdkVersion 2022-08-09 12:52:07 +03:00
assets Selfhost font #397 2022-07-27 15:05:04 +03:00
fastlane/metadata/android/en-US
ios Update version 2022-08-08 11:44:29 +03:00
lib Dashboard overview 2022-08-14 17:02:00 +03:00
linux Improve SMS verification 2022-08-04 12:00:56 +03:00
macos Update podfile 2022-08-08 11:50:05 +03:00
samples
snap Update version 2022-08-08 11:33:55 +03:00
stubs Increase default API per_page to 100 for bulk actions 2022-07-22 13:51:02 +03:00
test_driver
web Selfhost canvaskit #396 2022-07-27 15:04:54 +03:00
windows Improve SMS verification 2022-08-04 12:00:56 +03:00
.gitignore
.metadata Update macos wrappers to Flutter 3 2022-05-24 20:26:44 +03:00
LICENSE.txt
README.md App review 2022-07-06 12:00:40 +03:00
analysis_options.yaml Apply use_build_context_synchronously lint 2022-07-13 22:26:16 +03:00
invoiceninja.iml
invoiceninja_android.iml
pubspec.foss.yaml Dashboard overview 2022-08-11 20:20:06 +03:00
pubspec.lock Dashboard overview 2022-08-11 20:20:06 +03:00
pubspec.next.yaml Dashboard overview 2022-08-11 20:20:06 +03:00
pubspec.yaml Dashboard overview 2022-08-11 20:20:06 +03:00
run_all_it_tests.sh
starter.sh Purchase orders 2022-06-14 12:43:06 +03:00

README.md

Invoice Ninja

Client app for Invoice Ninja.

Dashboard View Invoice List Invoice New Invoice

Setting up the app

  • Initialize the config file

    cp lib/.env.dart.example lib/.env.dart

  • Support running the code unsigned on Android

    cp android/app/build.gradle.dev android/app/build.gradle

  • Run the app

    flutter run

Note: if you don't have an Invoice Ninja backend setup you can test the app with these credentials:

  • Email: demo@invoiceninja.com
  • Password: Password0
  • URL: demo.invoiceninja.com

Steps to remove non-FOSS code

cp android/build.gradle.foss android/build.gradle
cp lib/utils/oauth.dart.foss lib/utils/oauth.dart
cp lib/utils/app_review.dart.foss lib/utils/app_review.dart
cp lib/ui/app/upgrade_dialog.dart.foss lib/ui/app/upgrade_dialog.dart
cp android/app/src/main/AndroidManifest.foss.xml android/app/src/main/AndroidManifest.xml
cp pubspec.foss.yaml pubspec.yaml 
rm pubspec.lock

Application Architecture

The application was created using the Flutter Redux Starter.

The architecture is based off these two projects:

Blog Posts

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

  • Run flutter drive --target=test_driver/all_it.dart to run the tests

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.
  • Update android/key.properties according to the parameters you entered in previous command when you generated the key
  • Open a new Firebase project from your console. Firebase is used for authentication.
    • Inside the project go to Authentication and enable at least one method.
    • After go to add a new Android application. For the package name add com.invoiceninja.flutter
    • Press "Register App" button.
    • Download "google-services.json" and put it in android/app directory.

Credits

https://github.com/invoiceninja/invoiceninja#credits

Contributions

We gladly accept contributions! If you'd like to get involved with development please join our Slack group.