admin-portal

# Invoice Ninja

Client application for [Invoice Ninja](https://github.com/invoiceninja/invoiceninja).

#### Desktop Apps
- [Windows](https://apps.microsoft.com/store/detail/invoice-ninja/9N3F2BBCFDR6)
- [macOS](https://apps.apple.com/app/id1503970375?platform=mac)
- [Linux - Snap](https://snapcraft.io/invoiceninja)
- [Linux - Flatpak](https://flathub.org/apps/com.invoiceninja.InvoiceNinja)

#### Mobile Apps
- [iOS](https://apps.apple.com/app/id1503970375?platform=iphone)
- [Android](https://play.google.com/store/apps/details?id=com.invoiceninja.app)
- [F-Droid](https://f-droid.org/en/packages/com.invoiceninja.app)

<p align="center">
    <img src="https://github.com/invoiceninja/flutter-mobile/blob/master/samples/screenshots/1.png" alt="Dashboard" width="200"/>
    <img src="https://github.com/invoiceninja/flutter-mobile/blob/master/samples/screenshots/2.png" alt="View Invoice" width="200"/>
    <img src="https://github.com/invoiceninja/flutter-mobile/blob/master/samples/screenshots/3.png" alt="List Invoice" width="200"/>
    <img src="https://github.com/invoiceninja/flutter-mobile/blob/master/samples/screenshots/4.png" alt="New Invoice" width="200"/>
</p>

# Table of Contents

- [Setting up the app](#setting-up-the-app)
- [Steps to remove non-FOSS code](#steps-to-remove-non-foss-code)
- [Application Architecture](#application-architecture)
    - [Package Structure](#package-structure)
    - [Blog Posts](#blog-posts)
- [Code generation](#code-generation)
- [Tests](#tests)
- [Code signing](#code-signing)
- [Credits](#credits)
- [Contributions](#contributions)

---

## 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.kts android/app/build.gradle.kts`

- 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 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 lib/ui/app/pinput.dart.foss lib/ui/app/pinput.dart
cp android/app/src/main/AndroidManifest.foss.xml android/app/src/main/AndroidManifest.xml
cp android/settings.gradle.foss.kts android/settings.gradle.kts
cp pubspec.foss.yaml pubspec.yaml 
cp pubspec.foss.lock pubspec.lock
```

`pubspec.foss.yaml` and `pubspec.foss.lock` are generated from `pubspec.yaml` and `pubspec.lock` by `./update_foss.sh`, which `bump_version.sh` runs; don't edit them by hand.

## Application Architecture

The application was created using the [Flutter Redux Starter](https://github.com/hillelcoren/flutter-redux-starter).

The architecture is based off these two projects:

- [Redux Sample](https://github.com/brianegan/flutter_architecture_samples/tree/master/redu