This repository has been archived on 2023-08-16. You can view files and clone it, but cannot push or open issues or pull requests.
LocalSpend-Tracker/README.md

100 lines
2.7 KiB
Markdown
Raw Permalink Normal View History

2021-03-20 09:40:50 +00:00
# LocalSpend (Mobile App.)
2019-01-22 20:20:10 +00:00
2021-03-20 09:40:50 +00:00
Looking to discover if the value of spending local can be measured, understood and shown.
2019-01-22 20:20:10 +00:00
2021-03-20 09:40:50 +00:00
This repository contains the mobile application for the LocalSpend system. See also:
2019-01-22 20:20:10 +00:00
2021-03-20 09:40:50 +00:00
* the [Web application](https://github.com/Pear-Trading/Foodloop-Web); and
* the [server](https://github.com/Pear-Trading/Foodloop-Server).
2020-07-29 14:11:33 +00:00
2021-03-20 09:40:50 +00:00
## Table of Contents
2020-07-29 14:11:33 +00:00
2021-03-20 09:40:50 +00:00
* [Tech Stack](#tech-stack)
* [Features](#features)
* [Installation](#installation)
* [Configuration](#configuration)
* [Usage](#usage)
* [Testing](#testing)
* [Code Formatting](#code-formatting)
* [Documentation](#documentation)
* [Acknowledgments](#acknowledgements)
* [License](#license)
2021-03-20 09:43:18 +00:00
* [Contact](#contact)
2021-03-20 09:40:50 +00:00
## Technology Stack
2021-03-20 09:40:50 +00:00
The mobile app. is written in [Dart](https://dart.dev/).
2021-03-20 09:40:50 +00:00
| 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';
```
2021-03-20 09:40:50 +00:00
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](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
2019-01-22 20:20:10 +00:00
2021-03-20 09:40:50 +00:00
This project is released under the [MIT license](https://mit-license.org/).
2019-01-22 20:20:10 +00:00
2021-03-20 09:40:50 +00:00
## Contact
2019-01-22 20:20:10 +00:00
2021-03-20 09:40:50 +00:00
| Name | Link(s) |
|----------------|-------------------|
| Mark Keating | [Email][mkeating] |
| Michael Hallam | [Email][mhallam] |
2021-03-20 09:40:50 +00:00
[mkeating]: mailto:m.keating@shadowcat.co.uk
[mhallam]: mailto:info@lancasteresta.org