• Introduction
• Overview
• Installation
• Development
  • Debugging
  • Error Tracking

The Photo ID app is a research tool that can be used for photo-identification methodologies for longitudinal mark-recapture studies. It allows for the organisation and matching of photographs containing unique identification markings (such as cetacean dorsal fins). It includes tools for editing and visually filtering photographs to help with identification of marks.

📚 For more information and user guides, check out the docs.

The app is made up of the following parts:

• src/ contains the main app code
• src/assets contains app assets (e.g. icons)
• src/backend contains backend (main) controllers
• src/contexts contains React contexts
• src/frontend contains frontend (renderer) views and components
• src/models contains classes used in the frontend
• src/routes contains frontend routes
• src/index.tsx contains the frontend (renderer) entry point
• src/main.ts contains the backend (main) entry point
• src/preload.ts contains preloaded app methods

1. Clone the repository
2. Ensure you are using Node version >= 24 (nvm install 24 / nvm use 24)
3. Install the dependencies by running npm ci
4. If using VS Code install the ESLint, Stylelint, and Prettier extensions

Below are the NPM commands that can be used for development:

Using VSCode, a debugger can be attached to the main process in Electron by running "Debug main process" in the Run and Debug view.

The app uses Sentry to track errors and logs for debugging in published production builds. To enable this locally, add an .env file to the root of the repository using the variables defined in .env.example. This file also needs to be created when publishing to ensure the values are included in the production build.