LocalSpend-Tracker/README.md

LocalSpend (Mobile App.)

Looking to discover if the value of spending local can be measured, understood and shown.

This repository contains the mobile application for the LocalSpend system. See also:

• the Web application; and
• the server.

Table of Contents

• Tech Stack
• Features
• Installation
• Configuration
• Usage
• Testing
• Code Formatting
• Documentation
• Acknowledgments
• License
• Contact

Technology Stack

The mobile app. is written in Dart.

Technology	Description	Link
Flutter	Cross-platform mobile framework	Link

Features

This mobile app. provides:

• user authentication; and
• transaction logging.

Installation

1. Install Flutter;
2. if this is your first Flutter project, install the Flutter SDK;
3. set up your editor:
   • we recommend using Android Studio.
4. 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:

import 'package:flutter/foundation.dart';

After that, you can generate debugging output using debugPrint().

Production

Run flutter build apk -t lib/main_dev.dart to generate an APK file.

Testing

TODO

Code Formatting

TODO

Documentation

TODO

Acknowledgements

LocalLoop is the result of collaboration between the Small Green Consultancy, Shadowcat Systems, Independent Lancaster and the Ethical Small Traders Association.

License

This project is released under the MIT license.

Contact

Name	Link(s)
Mark Keating	Email
Michael Hallam	Email