Skip to content
Alex Cornforth edited this page Aug 31, 2020 · 1 revision

Welcome to the treetracker-ios wiki!

The document gives a brief overview of the purpose, functionality of Treetracker iOS app and its current software implementation details.

It is divided into three sections:

1. Product Documentation: Captures the intent and use cases for the Treetracker App.

2. Engineering Documentation: Presents the design, data model and implementation details of the product features.

3. Release Documentation: Details on the release process.

Product Documentation

This section has the following topics

Overview

Intended Users

  • Primary Users

  • Secondary Users

Considerations and Constraints

Planter Registration, Login and Identification

Planter activity verification and Payout Data

User stories

Engineering Documentation

For developer contributors, this section contains the current design of the software components used in the application. Some of the implementation details presented are for the following features

  • Data and Entity models used for storing data
  • UI Architecture
  • Navigation flows
  • Planter login /signup process
  • Tree capture and associated flows
  • Syncing of planter info and tree's planted

Release Documentation

For developers and others involved in releasing the app, this sections provides information on the following:

  • How to build
  • How to release
  • Status of the current build
Clone this wiki locally