Update readme

This commit is contained in:
Hillel Coren 2020-03-17 18:14:43 +02:00
parent 75b14eb411
commit 6a86f70e91
1 changed files with 6 additions and 23 deletions

View File

@ -1,6 +1,6 @@
# Invoice Ninja
Companion app for the [Invoice Ninja](https://github.com/invoiceninja/invoiceninja) web app.
Client app for the [Invoice Ninja](https://github.com/invoiceninja/invoiceninja) web app.
- [Google Play Store](https://play.google.com/store/apps/details?id=com.invoiceninja.flutter)
- [Apple App Store](https://itunes.apple.com/us/app/invoice-ninja/id1435514417?ls=1&mt=8)
@ -14,21 +14,6 @@ Note: the mobile app requires the latest version of the web app.
<img src="https://github.com/invoiceninja/flutter-mobile/blob/master/samples/screenshots/screenshot_04.png" alt="Edit Product" width="200"/>
</p>
## Features
- [x] Dashboard
- [x] Clients
- [x] Products
- [x] Invoices
- [x] Quotes
- [x] Payments
- [x] Projects
- [x] Tasks
- [x] Vendors
- [x] Expenses
- [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.
@ -44,11 +29,11 @@ The architecture is based off these two projects:
- [inKino](https://github.com/roughike/inKino) - [Iiro Krankka](https://twitter.com/koorankka)
### Blog Posts
- [Intro to Google Flutter](https://hillelcoren.com/2018/05/18/flutter-is-darts-killer-app/)
- [Using Redux to manage state](https://hillelcoren.com/2018/06/01/building-a-large-flutter-app-with-redux/)
- [Handling complex forms](https://hillelcoren.com/2018/06/18/flutter-using-redux-to-manage-complex-forms-with-multiple-tabs-and-relationships/)
- [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/)
- [Intro to Google Flutter](https://hillel.dev/2018/05/18/flutter-is-darts-killer-app/)
- [Using Redux to manage state](https://hillel.dev/2018/06/01/building-a-large-flutter-app-with-redux/)
- [Handling complex forms](https://hillel.dev/2018/06/18/flutter-using-redux-to-manage-complex-forms-with-multiple-tabs-and-relationships/)
- [Architectural review](https://hillel.dev/2018/08/10/an-architectural-review-of-the-invoice-ninja-flutter-app/)
- [Additional thoughts](https://hillel.dev/2018/08/24/ongoing-adventures-with-flutter-and-redux/)
## 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..
@ -79,5 +64,3 @@ The architecture is based off these two projects:
## Contributions
We gladly accept contributions! If you'd like to get involved with development please join our [Slack group](http://slack.invoiceninja.com/).
Create pull requests for v1 against the 'legacy' branch and for v2 against the 'develop' branch.