Skip to content

elliotttf/vole

 
 

Repository files navigation

Vole

Vole is a web application for sharing words, pictures and videos with others. Data is distributed peer-to-peer using Bittorrent Sync.

A complete introduction is available on vole.cc.

Getting started

Currently we are pre-release, so there are no builds available. The following steps are for interested developers.

  • Compile and run the Go backend. See contributing.
  • Open a web browser and go to http://localhost:6789.
  • Click 'My Profile'
  • Enter your name. Enter your Gravatar email (optional).
  • Click 'Home'
  • Post something.

Sharing and following

Start by installing Bittorrent Sync.

Following and sharing currently involves manually setting up folders, however we'd like to automate it as soon as Bittorrent Sync releases a build that supports command-line control.

Following others

  • Grab the read-only ID of the person you want to follow. A directory is in progress at vole.cc. Why not start with Vole Team updates? Our key is RA32XLBBHXMWMECGJAJSJMMPQ3Z2ZGR7K.
  • Find the Vole users folder. Unless you changed the defaults, it will be in ~/Vole/users.
  • Create a new folder in ~/Vole/users, you can name it whatever you like.
  • In BitTorrent Sync, add this new folder as a shared folder. Instructions are available on their site.
  • You should receive notification that the folder has sync'd.
  • In your browser, see the new posts appear.

Sharing your posts

Find your own user folder, for example, if you created a profile named 'Chuck':

/home/chuck/Vole/users/Chuck_9674e8e8-7c7a-41e6-52ed-51a3f7969812
  • In Bittorrent Sync, add this folder as a shared folder.
  • In the folder options, grab the read-only key. This is the key that you can share to others so they can follow your posts.

Profile site

We plan on allowing people to claim their names on vole.cc and store their keys along with their profile, making it much easier to find people who are posting publicly.

Versions

Vole uses semantic versioning

Technology

License

Copyright (C) 2013 Vole development team

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Vole is a social, peer-to-peer web app for sharing words, pictures and videos.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 91.7%
  • JavaScript 8.3%