Fix typo

Update readme
2021-03-20 09:43:18 +00:00 · 2021-03-20 09:40:50 +00:00
10 changed files with 130 additions and 194 deletions
--- a/README.md
+++ b/README.md
@ -1,47 +1,99 @@
-# LocalSpend Mobile App.
+# LocalSpend (Mobile App.)

-This repo. contains the mobile application for use with the LocalSpend system, 
-using Flutter.
+Looking to discover if the value of spending local can be measured, understood and shown.

-## Getting Started
+This repository contains the mobile application for the LocalSpend system. See also:

-Follow these steps to get the project up-and-running:
+* the [Web application](https://github.com/Pear-Trading/Foodloop-Web); and
+* the [server](https://github.com/Pear-Trading/Foodloop-Server).

-1. Install [Flutter](https://flutter.dev/docs/get-started/install)
-1. Set up [your editor](https://flutter.dev/docs/get-started/editor)
-    1. If this is your first Flutter project, install the [Flutter SDK](https://flutter.dev/docs/get-started/test-drive)
-1. Add the line `flutter.sdk=⟨ path to Flutter SDK ⟩` to the file `androud/local.properties`
+## Table of Contents

-## Building
+* [Tech Stack](#tech-stack)
+* [Features](#features)
+* [Installation](#installation)
+* [Configuration](#configuration)
+* [Usage](#usage)
+* [Testing](#testing)
+* [Code Formatting](#code-formatting)
+* [Documentation](#documentation)
+* [Acknowledgments](#acknowledgements)
+* [License](#license)
+* [Contact](#contact)

-To build an apk from dev, use:
-```
-flutter build apk -t lib/main_dev.dart
-```
+## Technology Stack

-## Debugging
+The mobile app. is written in [Dart](https://dart.dev/).

-```
-// debug
+| Technology  | Description         						| Link                |
+|-------------|---------------------------------|---------------------|
+| Flutter 		| Cross-platform mobile framework	| [Link][flutter]     |
+
+[flutter]: https://flutter.dev/
+
+## Features
+
+This mobile app. provides:
+
+- user authentication; and
+- transaction logging.
+
+## Installation
+
+1. Install [Flutter](https://flutter.dev/docs/get-started/install);
+1. if this is your first Flutter project, install the [Flutter SDK](https://flutter.dev/docs/get-started/test-drive);
+1. set up [your editor](https://flutter.dev/docs/get-started/editor):
+    - we recommend using [Android Studio](https://developer.android.com/studio).
+1. add the line `flutter.sdk=⟨ path to Flutter SDK ⟩` to the file `android/local.properties`.
+
+## Configuration
+
+App. configuration settings are found in `pubspec.yaml`.
+
+Build settings are found in the `android/` directory, in the `build.gradle`, `gradle.properties` and `settings.gradle` files.
+
+## Usage
+
+### Development
+
+To activate debugging, add the following import statement:
+
+```dart
 import 'package:flutter/foundation.dart';
-debugPrint('$foo');
 ```

-## Further Reading
+After that, you can generate debugging output using `debugPrint()`.

-A few resources to get you started if this is your first Flutter project:
+### Production

- [Lab: Write your first Flutter app](https://flutter.io/docs/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://flutter.io/docs/cookbook)
+Run `flutter build apk -t lib/main_dev.dart` to generate an APK file.

-For help getting started with Flutter, view our 
-[online documentation](https://flutter.io/docs), which offers tutorials, 
-samples, guidance on mobile development, and a full API reference.
+## Testing

-https://github.com/putraxor/flutter-login-ui
-https://github.com/pbirdsall/medium_splash_tokenauth
+TODO

-Related repos:
+## Code Formatting

- [`Pear-Trading/FoodLoop-Web`](https://github.com/Pear-Trading/FoodLoop-Web)
- [`Pear-Trading/Foodloop-Server`](https://github.com/Pear-Trading/Foodloop-Server)
+TODO
+
+## Documentation
+
+TODO
+
+## Acknowledgements
+
+LocalLoop is the result of collaboration between the [Small Green Consultancy](http://www.smallgreenconsultancy.co.uk/), [Shadowcat Systems](https://shadow.cat/), [Independent Lancaster](http://www.independent-lancaster.co.uk/) and the [Ethical Small Traders Association](http://www.lancasteresta.org/).
+
+## License
+
+This project is released under the [MIT license](https://mit-license.org/).
+
+## Contact
+
+| Name           | Link(s)           |
+|----------------|-------------------|
+| Mark Keating   | [Email][mkeating] |
+| Michael Hallam | [Email][mhallam]  |
+
+[mkeating]: mailto:m.keating@shadowcat.co.uk
+[mhallam]: mailto:info@lancasteresta.org
--- a/android/app/build.gradle
+++ b/android/app/build.gradle
@ -8,7 +8,7 @@ if (localPropertiesFile.exists()) {

 def flutterRoot = localProperties.getProperty('flutter.sdk')
 if (flutterRoot == null) {
-    throw GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
+    throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
 }

 def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
@ -58,7 +58,4 @@ dependencies {
    testImplementation 'junit:junit:4.12'
    androidTestImplementation 'com.android.support.test:runner:1.0.2'
    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
-    implementation 'com.google.firebase:firebase-messaging:20.3.0'
 }
-
-apply plugin: 'com.google.gms.google-services'
--- a/android/app/src/main/AndroidManifest.xml
+++ b/android/app/src/main/AndroidManifest.xml
@ -14,7 +14,6 @@
         FlutterApplication and put your custom class here. -->
    <application
        android:label="SpendTracker"
-        android:name=".Application"
        android:icon="@mipmap/ic_launcher">

        <meta-data
--- a/android/app/src/main/java/uk/co/localspend/localspend/Application.java
+++ b/android/app/src/main/java/uk/co/localspend/localspend/Application.java
@ -1,21 +0,0 @@
-package uk.co.localspend.localspend;
-
-import io.flutter.app.FlutterApplication;
-import io.flutter.plugin.common.PluginRegistry;
-import io.flutter.plugin.common.PluginRegistry.PluginRegistrantCallback;
-import io.flutter.plugins.GeneratedPluginRegistrant;
-import io.flutter.plugins.firebasemessaging.FlutterFirebaseMessagingService;
-import io.flutter.plugins.firebasemessaging.FirebaseMessagingPlugin;
-
-public class Application extends FlutterApplication implements PluginRegistrantCallback {
-    @Override
-    public void onCreate() {
-        super.onCreate();
-        FlutterFirebaseMessagingService.setPluginRegistrant(this);
-    }
-
-    @Override
-    public void registerWith(PluginRegistry registry) {
-        FirebaseMessagingPlugin.registerWith(registry.registrarFor("io.flutter.plugins.firebasemessaging.FirebaseMessagingPlugin"));
-    }
-}
--- a/android/build.gradle
+++ b/android/build.gradle
@ -5,8 +5,7 @@ buildscript {
    }

    dependencies {
-        classpath 'com.android.tools.build:gradle:4.0.1'
-        classpath 'com.google.gms:google-services:4.3.4'
+        classpath 'com.android.tools.build:gradle:3.3.0'
    }
 }

--- a/android/gradle/wrapper/gradle-wrapper.properties
+++ b/android/gradle/wrapper/gradle-wrapper.properties
@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.1.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-all.zip
--- a/lib/env/dev.json
+++ b/lib/env/dev.json
@ -1,5 +1,5 @@
 {
  "env": "DEV",
  "production": false,
-  "apiUrl": "https://localhost:/api"
+  "apiUrl": "https://dev.localspend.co.uk/api"
 }
--- a/lib/main.dart
+++ b/lib/main.dart
@ -7,12 +7,9 @@ import 'package:local_spend/pages/spash_screen.dart';
 import 'package:local_spend/pages/more_page.dart';
 import 'package:flutter_localizations/flutter_localizations.dart';
 import 'package:local_spend/common/apifunctions/get_graph_data.dart';
-import 'package:firebase_messaging/firebase_messaging.dart';

 void main() {
-  runApp(
-      MyApp()
-  );
+  runApp(MyApp());
 }

 void loadGraphs() {}
@ -25,43 +22,27 @@ class GraphWithTitle {
 }

 class MyApp extends StatelessWidget {
-  final FirebaseMessaging _firebaseMessaging = FirebaseMessaging();
  @override
  Widget build(BuildContext context) {
    // TODO: load graphs on app login and send to graph widgets

-    _firebaseMessaging.configure(
-      onMessage: (Map<String, dynamic> message) async {
-        print('onMessage: $message');
-      },
-      onLaunch: (Map<String, dynamic> message) async {
-        print('onLaunch: $message');
-      },
-      onResume: (Map<String, dynamic> message) async {
-        print('onResume: $message');
-      },
-    );
-
-    // Required on iOS; non-op on Android.
-    _firebaseMessaging.requestNotificationPermissions();
-
-    return MaterialApp(
+    return new MaterialApp(
      debugShowCheckedModeBanner: false,
      localizationsDelegates: [
        GlobalMaterialLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
      ],
-      supportedLocales: [Locale('en')],
-      title: 'Local Spend Tracker',
-      theme: ThemeData(
+      supportedLocales: [Locale("en")],
+      title: "Local Spend Tracker",
+      theme: new ThemeData(
        primarySwatch: Colors.blueGrey,
      ),
      routes: <String, WidgetBuilder>{
-        '/HomePage': (BuildContext context) => HomePage(),
-        '/LoginPage': (BuildContext context) => LoginPage(),
+        "/HomePage": (BuildContext context) => HomePage(),
+        "/LoginPage": (BuildContext context) => LoginPage(),
        '/MapPage': (BuildContext context) => MapPage(),
-        '/ReceiptPage': (BuildContext context) => ReceiptPage2(),
-        '/MorePage': (BuildContext context) => MorePage(),
+        "/ReceiptPage": (BuildContext context) => ReceiptPage2(),
+        "/MorePage": (BuildContext context) => MorePage(),
      },
      home: SplashScreen(),
    );
--- a/pubspec.lock
+++ b/pubspec.lock
@ -14,7 +14,7 @@ packages:
      name: analyzer
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "0.39.14"
+    version: "0.39.15"
  args:
    dependency: transitive
    description:
@ -63,21 +63,21 @@ packages:
      name: build_resolvers
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.3.11"
+    version: "1.3.10"
  build_runner:
    dependency: "direct dev"
    description:
      name: build_runner
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.10.1"
+    version: "1.10.0"
  build_runner_core:
    dependency: transitive
    description:
      name: build_runner_core
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "6.0.1"
+    version: "5.2.0"
  built_collection:
    dependency: transitive
    description:
@ -147,7 +147,7 @@ packages:
      name: code_builder
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "3.5.0"
+    version: "3.4.0"
  collection:
    dependency: transitive
    description:
@ -204,13 +204,6 @@ packages:
      url: "https://pub.dartlang.org"
    source: hosted
    version: "1.1.0"
-  ffi:
-    dependency: transitive
-    description:
-      name: ffi
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "0.1.3"
  file:
    dependency: transitive
    description:
@ -218,41 +211,6 @@ packages:
      url: "https://pub.dartlang.org"
    source: hosted
    version: "5.2.1"
-  firebase:
-    dependency: transitive
-    description:
-      name: firebase
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "7.3.0"
-  firebase_core:
-    dependency: transitive
-    description:
-      name: firebase_core
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "0.5.0+1"
-  firebase_core_platform_interface:
-    dependency: transitive
-    description:
-      name: firebase_core_platform_interface
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "2.0.0"
-  firebase_core_web:
-    dependency: transitive
-    description:
-      name: firebase_core_web
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "0.2.0"
-  firebase_messaging:
-    dependency: "direct main"
-    description:
-      name: firebase_messaging
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "7.0.3"
  fixnum:
    dependency: transitive
    description:
@ -290,7 +248,7 @@ packages:
      name: flutter_plugin_android_lifecycle
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.0.11"
+    version: "1.0.8"
  flutter_test:
    dependency: "direct dev"
    description: flutter
@ -314,14 +272,14 @@ packages:
      name: google_maps_flutter
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "0.5.33"
+    version: "0.5.28+1"
  google_maps_flutter_platform_interface:
    dependency: transitive
    description:
      name: google_maps_flutter_platform_interface
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.0.4"
+    version: "1.0.2"
  graphs:
    dependency: transitive
    description:
@ -335,7 +293,7 @@ packages:
      name: html
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "0.14.0+4"
+    version: "0.14.0+3"
  http:
    dependency: "direct main"
    description:
@ -384,14 +342,14 @@ packages:
      name: json_annotation
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "3.1.0"
+    version: "3.0.1"
  json_serializable:
    dependency: "direct main"
    description:
      name: json_serializable
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "3.5.0"
+    version: "3.3.0"
  linkify:
    dependency: transitive
    description:
@ -426,7 +384,7 @@ packages:
      name: mime
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "0.9.7"
+    version: "0.9.6+3"
  node_interop:
    dependency: transitive
    description:
@ -468,14 +426,7 @@ packages:
      name: path_provider_platform_interface
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.0.3"
-  path_provider_windows:
-    dependency: transitive
-    description:
-      name: path_provider_windows
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "0.0.4+1"
+    version: "1.0.2"
  pedantic:
    dependency: "direct dev"
    description:
@ -490,13 +441,20 @@ packages:
      url: "https://pub.dartlang.org"
    source: hosted
    version: "2.2.1"
+  platform_detect:
+    dependency: transitive
+    description:
+      name: platform_detect
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.4.0"
  plugin_platform_interface:
    dependency: transitive
    description:
      name: plugin_platform_interface
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.0.3"
+    version: "1.0.2"
  pool:
    dependency: transitive
    description:
@ -538,21 +496,21 @@ packages:
      name: sa_anicoto
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.0.3"
+    version: "1.0.2"
  sa_multi_tween:
    dependency: transitive
    description:
      name: sa_multi_tween
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.1.2"
+    version: "1.1.1"
  sa_stateless_animation:
    dependency: transitive
    description:
      name: sa_stateless_animation
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.0.3"
+    version: "1.0.1"
  sa_v1_migration:
    dependency: transitive
    description:
@ -566,14 +524,14 @@ packages:
      name: shared_preferences
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "0.5.12"
+    version: "0.5.8"
  shared_preferences_linux:
    dependency: transitive
    description:
      name: shared_preferences_linux
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "0.0.2+2"
+    version: "0.0.2+1"
  shared_preferences_macos:
    dependency: transitive
    description:
@ -595,20 +553,13 @@ packages:
      url: "https://pub.dartlang.org"
    source: hosted
    version: "0.1.2+7"
-  shared_preferences_windows:
-    dependency: transitive
-    description:
-      name: shared_preferences_windows
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "0.0.1+1"
  shelf:
    dependency: transitive
    description:
      name: shelf
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "0.7.9"
+    version: "0.7.7"
  shelf_web_socket:
    dependency: transitive
    description:
@ -622,7 +573,7 @@ packages:
      name: simple_animations
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "2.2.2"
+    version: "2.2.1"
  sky_engine:
    dependency: transitive
    description: flutter
@ -634,7 +585,7 @@ packages:
      name: source_gen
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "0.9.7+1"
+    version: "0.9.6"
  source_span:
    dependency: transitive
    description:
@ -676,14 +627,7 @@ packages:
      name: supercharged
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.10.0"
-  supercharged_dart:
-    dependency: transitive
-    description:
-      name: supercharged_dart
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "1.2.0"
+    version: "1.7.0"
  term_glyph:
    dependency: transitive
    description:
@ -718,7 +662,7 @@ packages:
      name: url_launcher
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "5.7.2"
+    version: "5.5.0"
  url_launcher_linux:
    dependency: transitive
    description:
@ -732,28 +676,21 @@ packages:
      name: url_launcher_macos
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "0.0.1+8"
+    version: "0.0.1+7"
  url_launcher_platform_interface:
    dependency: transitive
    description:
      name: url_launcher_platform_interface
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.0.8"
+    version: "1.0.7"
  url_launcher_web:
    dependency: transitive
    description:
      name: url_launcher_web
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "0.1.4+1"
-  url_launcher_windows:
-    dependency: transitive
-    description:
-      name: url_launcher_windows
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "0.0.1+1"
+    version: "0.1.2"
  vector_math:
    dependency: transitive
    description:
@ -775,13 +712,6 @@ packages:
      url: "https://pub.dartlang.org"
    source: hosted
    version: "1.1.0"
-  win32:
-    dependency: transitive
-    description:
-      name: win32
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "1.7.3"
  xdg_directories:
    dependency: transitive
    description:
--- a/pubspec.yaml
+++ b/pubspec.yaml
@ -28,7 +28,6 @@ dependencies:
  simple_animations: ^2.2.1
  google_maps_flutter: ^0.5.20+5
  json_serializable: ^3.3.0
-  firebase_messaging: ^7.0.0
  # The following adds the Cupertino Icons font to your application.
  # Use with the CupertinoIcons class for iOS style icons.
  cupertino_icons: ^0.1.2
Author	SHA1	Message	Date
Rumperuu	ceafbb279f	Fix typo	2021-03-20 09:43:18 +00:00
Rumperuu	9381458d79	Update readme	2021-03-20 09:40:50 +00:00