Skip to content
master
Switch branches/tags
Code
This branch is 59 commits behind automerge:master.
Contribute
Fetch upstream

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ARCHIVED: This version of PushPin is archived for posterity and represents (mostly) work done under the aegis of Ink & Switch Labs. Today, PushPin is developed by a group of open-source developers and can be found at http://github.com/automerge/pushpin .

PushPin

A collaborative corkboard app. Designed to collect all the information you need and synchronize it across all your computers. PushPin supports taking notes, and can archive web content, images, PDFs, audio, video, and any other files you might want to hang out. It can synchronize across all your devices, and doesn't require any infrastructure to operate.

Join our Slack to ask questions, share ideas, or meet other users!

Built with Electron, React, automerge and hypermerge.

A project initiated by Ink & Switch.

WARNING

PushPin is experimental software and currently implements an extremely open and permissive sharing system!

You should be extremely cautious about putting private personal data into PushPin. While the development team has no access to data in PushPin, once shared PushPin links cannot be unshared or redacted!

See WARNINGS for more details, and feel free to ask questions in Slack or GitHub issues.

Running from Source

$ nvm use 12
$ yarn
$ yarn start

To enable debug logging, e.g.:

$ DEBUG=* yarn start
$ DEBUG=pushpin:* yarn start
$ DEBUG=pushpin:card,hypermerge:* yarn start

To run multiple clients and test syncing:

$ yarn run start2

This is an alias for:

$ NAME=userA yarn start & NAME=userB yarn dev:app

User data is stored in a platform-dependent, shared location outside of the source code directory. To get the path to your data directory, run in the console:

> require('./constants').USER_PATH
"/Users/mmcgrana/Library/Application Support/PushPin/pushpin-v11/mark"

On Mac, this is currently: ~/Library/Application Support/pushpin/. On Windows, it is: ~\AppData\Roaming\PushPin

Per-NAME data is stored under that directory inside pushpin-v11. (The number may be higher if you're reading this in the future and we forgot to update the readme.) You can remove a single directory from to reset a user's data, or remove the entire data directory to reset all user data.

Using PushPin

PushPin is an offline-first collaborative cork board. You can make new text notes by double-clicking, and drag-and-drop or paste in text, images, PDFs, audio files, video files, URLs, or even arbitrary other files to a board.

You can also drag boards and contacts from the search bar onto a board, right click to create new elements like conversation threads or change the background color of a board.

In the top left is your avatar image. Double-click it to begin editing your profile. Give yourself a name and a profile picture, then invite someone else to see your work by clicking the clipboard in the search box to copy the URL.

They'll have to paste that link into their search bar and with that, you'll be connected.

You can navigate new places quickly by pressing "/" and then typing part of the name of the board you want to go to or the person you want to share your current view with.

Clipper Chrome Extension

PushPin integrates with the Clipper chrome extension (repo) to save content from webpages into Pushpin. To set up Clipper, follow the steps in the Clipper README to install the extension.

You should now be able to clip content using the Clipper extension and have it show up in your Omnibox!

Keeping Your Data Available

pushpin-peer is a simple data peer you can use to ensure your pushpin data is available. You can run pushpin peer on a server or in the cloud.

Hacking on PushPin

PushPin is built to be easily extended. You could add new kinds of cards like movies or music, a fancier text editor, a PDF viewer, a deck of cards, or a drum machine. You could replace our card layout with your own code, or build a 3d game using WebGL. The sky's the limit.

See HACKING for a getting started guide.

Packaging

Create a package for your platform with yarn dist.

Contributing

Please do! Bug reports and pull requests are welcome. Contributions will generally be considered and assessed following our DESIGN guidelines, though we may accept or reject a patch for any reason.

Credits

This project was written by

  • Roshan Choxi
  • Ignatius Gilfedder
  • Mark McGranaghan
  • Jeff Peterson
  • Matt Tognetti
  • Peter van Hardenberg and was produced under the auspices of Ink & Switch.

Special thanks to Martin Kleppmann (automerge) and Mathias Buus (hypercore) for their advice and contributions.

Contributions

Thanks in particular to the following individuals for sending bug fixes and feature improvements:

  • Jeremy Apthorp
  • Irakli Gozala

Upgrade Hackage Notes

sodium-native

Compiling sodium-native is a pain. Go into node_modules/sodium-native and run node preinstall if you have trouble.

package.json resolutions

  • "automerge": "github:automerge/automerge#opaque-strings"
    • Automerge's typescript declarations mess up opaque string types (string & { foo: bar }) when freezing objects, so we have a branch that supports it. Can remove after that branch is merged to automerge.

About

A collaborative corkboard app

Resources

License

Packages

No packages published