wildaid / o-fish-ios

iOS app for the Officer's Fishery Information Sharing Hub (O-FISH). The mobile app allows fisheries officers to document and share critical information gathered during a routine vessel inspection.

WildAid O-FISH iOS App

The WildAid Marine Program works to protect vulnerable marine environments.

O-FISH (Officer Fishery Information Sharing Hub) is a multi-platform application that enables officers to browse and record boarding report data from their mobile devices.

This repo implements the iOS O-FISH app.

Details on installing all applications making up the solution can be found here.

The details behind the data architecture, schema, and partitioning strategy are described in Realm Data and Partitioning Strategy Behind the WildAid O-FISH Mobile Apps.

Prerequisites

This is the iOS Mobile app for O-FISH. To build and use the app, you must first create and configure your serverless backend application using the WildAid O-FISH MongoDB Realm repo. Or you can easily get a login to the existing sandbox environment.

Building and running the app

To build:

• Find the Realm Application ID (through the MongoDB Realm UI) for your Realm app.
• Copy o-fish-ios/LocalConstants.swift.tmpl to o-fish-ios/LocalConstants.swift
• Set the realm_app_id in o-fish-ios/LocalConstants.swift
• pod install
  • Note: you may need to resolve dependencies by doing pod install --repo-update
• Build/run in Xcode
  • Select the "Product" menu, then the "Destination" item and choose either:
    • Your physical device, if you have it connected
    • The simulator you want to run the code on (e.g. iPhone 11), from the "iOS Simulators" submenu
  • Select the "Product" menu and then the "Run" item to build and run the application on the destination you just chose.
    • If you do not see your changes in the application, make sure to uninstall the application and try building again.

To be able to login to the app once it is built, you need to create a user in your instance of the O-FISH Realm App.

o-fish-ios's Issues

Overlay MPAs on Apple Maps

Need to figure out how this is done. Can it be done with polygons?

Implement new design for icon app, splash screen and login screen.

As a user, I want to use new design in the app, so I will feel new impression when using app

When going off duty, get a Duty report

When going off-duty, show reports filed during shift (reuse search results)

Vessel Record Top bar

color should be white and back arrow should be blue as per https://docs.google.com/document/d/1K-iSxSOaCVdMJweiwOUwVO92tVaCU7FjvlUmco11tgY/edit#bookmark=id.dq8cge8hiqp4

Previous Boardings

As per https://docs.google.com/document/d/1K-iSxSOaCVdMJweiwOUwVO92tVaCU7FjvlUmco11tgY/edit#bookmark=id.rdglysq5v2ji pill text should be semibold weight; page shouldn't stick so records scroll all the way up; font size of violation info should be 15pt.

Vessel Profile

As per https://docs.google.com/document/d/1K-iSxSOaCVdMJweiwOUwVO92tVaCU7FjvlUmco11tgY/edit#bookmark=id.l5vflqjb5z2u font size of vessel name should be 20pt; font size of permit should be 15pt; spacing should match design in https://mongodb.invisionapp.com/share/RWX43EEF567#/screens/415937316

Use Realm query results for Menu options

Recently Boarded Title

In Find records and new boardings search: Title should be semibold and 20pt as per https://docs.google.com/document/d/1K-iSxSOaCVdMJweiwOUwVO92tVaCU7FjvlUmco11tgY/edit#bookmark=id.qy9manpdxfcf

Top bar on homepage

As per https://docs.google.com/document/d/1K-iSxSOaCVdMJweiwOUwVO92tVaCU7FjvlUmco11tgY/edit#bookmark=id.xvkqlnge3t6 search should live in the same container as the officer info/duty switch/status bar; Background should be white; on/off duty switch text should not be in all caps; font size should be 12pt with the pill big enough to accommodate.

When going off duty- ability to change on/off-duty time

shift review - before or after showing reports?

Make clear that this repo is work-in-progress

Up-version to Realm Beta 3

Lat/Lon and location

Should be 70% opacity as per https://docs.google.com/document/d/1K-iSxSOaCVdMJweiwOUwVO92tVaCU7FjvlUmco11tgY/edit#bookmark=id.da8603nqznb8

Up-version to Realm Cocoa 10.0 Beta2 SDK

https://github.com/realm/realm-cocoa/releases

Localize report creation to French - iOS

Latitude/Longitude display

Don’t display the latitude and longitude as decimals - convert to degrees/minutes/seconds

Include a thumbnail when a photo is taken - iOS

When creating a new PhotoViewModel, should also generate a thumbnail image and store it in the thumbNail attribute. It should then be stored in Photo.thumbNail when saving to Realm.

Rebase to public Realm SDK

Should rebase to https://github.com/realm/realm-cocoa/releases/tag/v10.0.0-beta.1

Record List Item

In Find records and new boardings search: Record List Item vessel font size should be 15 pt and pill text should be semibold as per https://docs.google.com/document/d/1K-iSxSOaCVdMJweiwOUwVO92tVaCU7FjvlUmco11tgY/edit#bookmark=id.bk9nd9ux4kec

Add landscape support for taking photos - iOS

Allow dates to be used in Realm Custom user Data

Would allow us to include a dateCreated attributed in the User document in the backend Realm app.

Prompt are you still on duty? if app hasn't been on screen in 4 hours

Move application to the production MongoDB Realm environment

Align design for scrolling pickers (date picker, unit picker)

As a user I want to see fancy date and unit picker aligned in common design with other screens, so I don't feel UI discomfort nice when using app

Remove agency from Realm Objects

The agency name was only included in the model Objects as it was required by Realm Sync. Realm no longer has this restriction and so the agency attribute can be removed from the Realm Objects.

Ask for confirmation before logging out

Top Bar for searching

For Find Records and New Boardings search: Search should live in the same container as the status bar and navigation; background should be white; When the user taps 'find records' the keyboard should come up with the search field active. Users shouldn’t have to tap the search field again after tapping it on the homepage.

Currently it looks like this:

It should look like this:

iOS: Officer profile photo

Officers can upload/change a profile photo

iOS: MPA functionality proof-of-concept

Have a hard-coded square overlaying some of the map area to represent a Marine Protected Area. This should show up in the map screens, so the officer can see if they are within the borders of the MPA. There is no additional functionality associated with this (e.g. they are still allowed to board a vessel outside the MPA)

Duty report review when going off duty - ability to go back and not go off-duty

confirmation. Before or after shift review (time and boardings)?

Have on/off duty state persist between force closures of the app - iOS

At present, the state reverts to off duty if you kill and restart the app. Should persist the state locally on the device, or in Realm.

Localize report creation to Spanish - iOS

(there may already be a translation but if so, it was done by Google translate)

Test App - iOS

Catch weight - default for US

The default should be kilograms for everyone, then next on the list tonnes, then pounds and then metric tons. If the user is in the US (either by location, or they're part of a US agency?) then the default should be pounds

Page Background behind section containers

GLOBALLY - on every screen with containers and a background the background should be #F9FAFA as per https://docs.google.com/document/d/1K-iSxSOaCVdMJweiwOUwVO92tVaCU7FjvlUmco11tgY/edit#bookmark=id.3c3iw9qyxtiq

Disply most recent vessel photo on vessel page in search results

Disply most recent vessel photo on vessel page in search results - this is the photo at the top of the screen that also shows Board Vessel

Logout Modal

As per https://docs.google.com/document/d/1K-iSxSOaCVdMJweiwOUwVO92tVaCU7FjvlUmco11tgY/edit#bookmark=id.7naj5mqtqrl7 'choose the action' text should not be there and buttons should be separate.

Prompt are you still on duty? 10 hours after going on duty

Weight unit not selected if don't scroll the wheel

As a user, when I click button Select at the unit picker I want to first value already be prefilled, even if I wasn't scrolled wheel

Allow photos to be chosen from already-taken photos

iOS: Offline login on app

It would be great if we could login offline - would have to figure out security implications - but options are: 0) don't actually login, just store credentials (or hashed credentials?) to submit when online.

1. actual login info is in Realm db - for everyone, for last logged in user, for last 3 logged in users on device.

iOS Realm schema for MPA data

Use custom data to set the reporting officer in the Boarding report

These attributes are currently left empty, but should be set to the credentials of the user that's logged into the app.

	"reportingOfficer" : {
		"email" : "",
		"name" : {
			"first" : "",
			"last" : ""
		}
	},

Board Vessel button on homepage

Font size should be 22 point and specs should match https://docs.google.com/document/d/1K-iSxSOaCVdMJweiwOUwVO92tVaCU7FjvlUmco11tgY/edit#bookmark=id.igh1wqoc0kuv

Rebase onto Realm Beta 3 SDK

The new version of the SDK contains breaking SDK changes: realm/realm-swift#6575

photo attachments should use device compression to get images <3MB

Review TODOs

As a programmer, I want to see actual state of the code, so need to review and check the TODOs notes in code time after time.

Pre-Boarding search results

When a user clicks 'Board Vessel' and then does a search; if there are no records they get 'No results'. There should also be an option to 'Add new vessel' on that search results page as the first item - whether or not search results have been returned. This way if there are no results - or the desired result is not in the list - the user does not have to go back to the previous page.

FaceID Auth

Add faceID authentication into WildAid

Add CI/CD

As a reviewer and contributor I want to see the code build status (builds or not) on PRs and main branch.
Platform: Github Actions.