pieces-app / opensource

Main repo for tracking open source projects, issues, conversations, and links to each open source project.
MIT License
168 stars 20 forks source link

Github Sync with Pieces #1

Closed jwafu closed 10 months ago

jwafu commented 11 months ago

The core idea from @mason-at-pieces here is to create a temporary workaround that can be used as a way to sync over the next few months until the official sync is released.

Long term I think that a few things can come from this project:

  1. An open sourced package that we support that allows for users to select a folder and run a command in their terminal to automatically configure and setup github sync with any folder on a device
  2. A demo project that can serve as an SDK for Getting Started with Pieces OS - Working with Github
    • this is actually just the story that mason has already created by writing this solution
  3. We provide a high DAU feature in the short term for our users

My reasons for thinking behind this approach:

Take a look at this article: https://desktopofsamuel.com/how-to-sync-obsidian-vault-for-free-using-git And this forum thread in obsidian: https://forum.obsidian.md/t/guide-using-git-to-sync-your-obsidian-vault-on-android-devices/41887

Users could eventually use it as a tool to sync an arbitrary folder on their desktop for free!

But I think that this project is in a few stages:

  1. Deploy the readme to the docs site and provide resources for using sync with Pieces v.01
  2. Research, plan, design project idea

--[AFTER SYNC RELEASES to Prod]--

  1. Continue to explore the github sync and how we can leverage Pieces endpoints to create a useful free file sync system
  2. Deploy a separate js/dart/ where a user can select a folder to sync in their dev environment to add a file sync to their own project

These are just my initial thoughts - but the goal here would not be to release an open source project that is for syncing snippets with Pieces OS, but a more generic solution that we can build on top of for our specific use case and provide users the same opportunity through a deployed package.