Skip to main content

intro

title: Quickstart sidebar_position: 1​

This guide helps you run the basic workflow: export - analyze - excel.

What you will do​

  • Install the Researcher desktop app
  • Set credentials and participantId
  • Run Export, Analyze, and Excel

Steps​

1) Install the downloader​

Follow the install steps:

2) Prepare credentials and config​

You need:

  • A Firebase Admin service account key (JSON)
  • A participantId

The app stores local config under:

  • macOS and Linux: ~/.datacollection_researcher
  • Windows: %USERPROFILE%\\.datacollection_researcher

See: Configure the app

3) Run the workflow​

In the app, run steps in this order:

  • Step 1 - Export
  • Step 2 - Analyze
  • Step 3 - Excel

4) Check outputs​

Outputs are saved under:

  • macOS and Linux: ~/.datacollection_researcher/output/<participantId>/
  • Windows: %USERPROFILE%\\.datacollection_researcher\\output\\<participantId>\\

See: Output files and folders

5) Find logs​

If you run from source, logs are printed in the terminal. If you use the packaged app, capture the error message and share related files (remove secrets).

Common mistakes​

  • Running Excel before Analyze
  • Running Analyze before Export
  • Moving the credentials JSON after selecting it
  • Leaving participantId blank

Report issues​

When you report a bug, include:

  • Your OS version
  • App version (or git commit if running from source)
  • Which step failed (Export, Analyze, Excel)
  • The error message text (copy-paste)
  • Terminal output (if you ran from source)