Skip to content

Latest commit

 

History

History

desktop

Surfer Desktop App

⚠️ Looking for Surfer Protocol or the Surfer Python SDK?

Protocol: Surfer Protocol
SDK: Surfer Python SDK

Demo (click to view)

YouTube

Currently Supported Platforms

  • iMessages
  • Twitter Bookmarks
  • Notion
  • ChatGPT History
  • Gmail
  • LinkedIn Connections
  • Reddit (coming soon!)
  • GitHub (coming soon!)
  • Discord (coming soon!)
  • Spotify (coming soon!)

How it works

Surfer Diagram

  1. Click on "Export" to initiate the data extraction process.
  2. The app waits for the target page to load completely.
  3. The system checks if the user is signed in to the platform being scraped.
  4. If not signed in, the user is prompted to sign in.
  5. If signed in, the process continues.
  6. Once signed in, the app interacts with the platform's user interface.
  7. The app then scrapes the user's data from the platform.
  8. Finally, the extracted data is exported and saved to your local storage.

Sample Exported Data

  "platform_name": "X Corp",
  "name": "Twitter",
  "runID": "twitter-001-1724267514217",
  "timestamp": 1724267623318,
  "content": [
    "Twitter Post 1",
    "Twitter Post 2",
    "Twitter Post 3",
    ...
  ]
}

Getting Started

To download the app, head over to https://docs.surferprotocol.org/desktop/installation. Or you can go to the releases page.

For instructions on setting up the app locally and contributing to the project, please refer to the Contributing Guidelines, Helper Functions Documentation, and Guide to Adding New Platforms.

See the open issues for a full list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.

Built With

  • Electron
  • React
  • Tailwind
  • Shadcn UI

Contact

Surfer Discord Server - @SahilLalani0 - @JackBlair87 - @T0M_3D

Project Link: https://github.com/Surfer-Org/Protocol/tree/main/desktop

Acknowledgements