https://github.com/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.
https://github.com/wildaid/o-fish-ios

hacktoberfest hacktoberfest2020 hacktoberfest2021 ios ios-app ios-swift iphone-app mongodb mongodb-atlas mongodb-database mongodb-realm non-profit nonprofit realm-mobile-database swift swiftui wildaid

Last synced: about 1 month ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/wildaid/o-fish-ios
• Owner: WildAid
• License: apache-2.0
• Created: 2020-06-01T20:08:26.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-09-27T14:23:38.000Z (about 2 years ago)
• Last Synced: 2024-10-10T05:40:59.209Z (about 1 month ago)
• Topics: hacktoberfest, hacktoberfest2020, hacktoberfest2021, ios, ios-app, ios-swift, iphone-app, mongodb, mongodb-atlas, mongodb-database, mongodb-realm, non-profit, nonprofit, realm-mobile-database, swift, swiftui, wildaid
• Language: Swift
• Homepage:
• Size: 1.23 MB
• Stars: 33
• Watchers: 4
• Forks: 15
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# WildAid O-FISH iOS App

The [WildAid Marine Program](https://marine.wildaid.org/) 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](http://wildaid.github.io/).

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](https://developer.mongodb.com/how-to/realm-data-architecture-ofish-app).

## 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](https://github.com/WildAid/o-fish-realm). Or you can easily get a login to the existing [sandbox environment](https://bit.ly/ofishsandbox).

## Building and running the app

To build:

- Find the Realm Application ID (through the [MongoDB Realm UI](https://realm.mongodb.com)) 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](https://github.com/WildAid/o-fish-realm).