Protocol - GitLite

KO | EN

gitlite — search

#python #react #ai #golang #rust #deep-learning #linux #macos #windows #awesome #kubernetes #vue #awesome-list #openai

Protocol

(★ 1,475)

Open-source framework for exporting your personal data.

File Explorer

Download Latest Version (.zip)

- - README.md
- - config.yml
  - stale.yml
- - extensions.json
  - launch.json
  - settings.json
- - assets.d.ts
  - current_db.py
  - entitlements.mac.plist
  - error.png
  - icon.icns
  - icon.png
  - icon.svg
  - imessage_mac.py
  - imessage_windows.py
  - password-prompt.html
  - requirements.txt
  - search_vector_db.py
  - Surfer.png
  - SurferApp.png
  - SurferDemo.mp4
  - SurferDiagram.png
  - vectorize.py
  - windows_requirements.txt
- .editorconfig
- .eslintignore
- .eslintrc.js
- .gitattributes
- .gitignore
- ADD_PLATFORMS.md
- HELPER_FUNCTIONS.md
- package-lock.json
- package.json
- pnpm-lock.yaml
- postcss.config.js
- README.md
- tailwind.config.js
- tsconfig.json
- - helpers.js
- .eslintrc.json
- .gitignore
- CHANGELOG.md
- jsconfig.json
- LICENSE.md
- mdx-components.jsx
- next.config.mjs
- package-lock.json
- package.json
- postcss.config.js
- prettier.config.js
- README.md
- tailwind.config.js
- typography.js
- - hosting.ZGlzdA.cache
- - App.jsx
  - Business.jsx
  - index.css
  - main.jsx
- .firebaserc
- .gitignore
- eslint.config.js
- firebase.json
- index.html
- package-lock.json
- package.json
- postcss.config.js
- README.md
- tailwind.config.js
- vite.config.js
- - .gitignore
  - LICENSE
  - pyproject.toml
  - README.md
  - requirements.txt
  - setup.py
- .python-version
- pyproject.toml
- README.md
- uv.lock
.DS_Store
CONTRIBUTING.md
LICENSE
README.md
SETUP_GUIDE.MD

# Installation Guide

1. Get the code

git clone https://github.com/Surfer-Org/Protocol

Downloads the entire project code from GitHub to your computer.

cd Protocol

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

cd desktop

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r cookbook/python/knowledge-graph/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Surfer Protocol: An open-source framework for exporting your personal data

> ### ⚠️ Looking for the Surfer Desktop App or the Surfer Python SDK?
> Desktop App: [Surfer Desktop App](https://github.com/Surfer-Org/Protocol/blob/main/desktop/README.md)\
> SDK: [Surfer Python SDK](https://github.com/Surfer-Org/Protocol/blob/main/sdk/python/README.md)

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![](https://dcbadge.vercel.app/api/server/5KQkWApkYC)](https://discord.gg/5KQkWApkYC)

## Demo (click to view)

[![YouTube](http://i.ytimg.com/vi/2P25iOd14qw/hqdefault.jpg)](https://www.youtube.com/watch?v=HuLnEFlQsHE&ab_channel=SahilLalani)

## What is Surfer Protocol?

Surfer Protocol is an open-source framework for exporting your personal data.

Your personal data is siloed across many platforms and apps. Big tech companies have no incentive to give you easy access to your own data. Whether you want to make an AI clone that texts like you, reclaim your data from big tech, or leave a digital legacy, Surfer Protocol is the way to do it.

Currently, Surfer Protocol consists of a Python SDK and a Desktop App. The Desktop App is used for exporting your data from your favorite apps and services. The Python SDK is used for building applications off of your personal data.

## Features

- Desktop App for exporting data from your favorite apps and services
- Python SDK for building applications off of your personal data
- Cookbook for examples of how to use the Surfer Protocol Python SDK to build applications

## 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](https://raw.githubusercontent.com/Surfer-Org/Protocol/main/desktop/assets/SurferDiagram.png)

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

```json{
  "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](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](CONTRIBUTING.md) and [Setup Guide](SETUP_GUIDE.md).

See the [open issues](https://github.com/Surfer-Org/Protocol/issues) for a full list of proposed features (and known issues).

## License

Distributed under the MIT License. See [`LICENSE`](https://github.com/Surfer-Org/Protocol/blob/main/LICENSE) for more information.

## Built With

* [![Electron][Electron.js]][Electron-url]
* [![React][React.js]][React-url]
* [![Tailwind][Tailwind.css]][Tailwind-url]
* [![Shadcn UI][Shadcn.ui]][Shadcn-url]

## Contact

[Surfer Discord Server](https://discord.gg/Tjg7pjcFNP) - [@SahilLalani0](https://x.com/SahilLalani0) - [@JackBlair87](https://x.com/JackBlair87) - [@T0M_3D](https://x.com/T0M_3D)

Project Link: [https://github.com/Surfer-Org/Protocol/](https://github.com/Surfer-Org/Protocol/)

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=Surfer-Org/Protocol&type=Date)](https://star-history.com/#Surfer-Org/Protocol&Date)

## Acknowledgements

- [Electron React Boilerplate](https://github.com/electron-react-boilerplate/electron-react-boilerplate)

[contributors-shield]: https://img.shields.io/github/contributors/Surfer-Org/Protocol.svg?style=for-the-badge
[contributors-url]: https://github.com/Surfer-Org/Protocol/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Surfer-Org/Protocol.svg?style=for-the-badge
[forks-url]: https://github.com/Surfer-Org/Protocol/network/members
[stars-shield]: https://img.shields.io/github/stars/Surfer-Org/Protocol.svg?style=for-the-badge
[stars-url]: https://github.com/Surfer-Org/Protocol/stargazers
[issues-shield]: https://img.shields.io/github/issues/Surfer-Org/Protocol.svg?style=for-the-badge
[issues-url]: https://github.com/Surfer-Org/Protocol/issues
[license-shield]: https://img.shields.io/github/license/Surfer-Org/Protocol.svg?style=for-the-badge
[license-url]: https://github.com/Surfer-Org/Protocol/blob/main/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/sahil-lalani
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[Tailwind.css]: https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white
[Tailwind-url]: https://tailwindcss.com/
[Electron.js]: https://img.shields.io/badge/Electron-2B2E3A?style=for-the-badge&logo=electron&logoColor=9FEAF9
[Electron-url]: https://www.electronjs.org/
[Shadcn.ui]: https://img.shields.io/badge/Shadcn_UI-F05032?style=for-the-badge&logo=shadcn&logoColor=white
[Shadcn-url]: https://ui.shadcn.com/