Skip to content

README.md

Latest commit

 

History

History
57 lines (32 loc) · 2.9 KB

README.md

File metadata and controls

57 lines (32 loc) · 2.9 KB

Locker - the "me" platform Build Status

This is an open source project that helps me collect all of my personal data, from wherever it is, into one place, and then lets me do really awesome stuff with it.

Background Video

STATUS: eager-developer-friendly only at this point, we're working hard to make it usable for early adopters very soon, keep an eye on @lockerproject and @jeremie for progress, and come hang out with us on freenode IRC in #lockerproject.

We also have a mailing list setup. Join and say hello!

Getting Started

The Fast Way

Get the locker source code:

git clone https://github.com/LockerProject/Locker.git
cd Locker
git submodule update --init

Then install dependencies (this may take a little while):

apt-get install imagemagick
npm install
make deps
make

Before you run you'll need to setup the services that you are going to connect to. Follow the directions to Get API Keys.

To turn on the locker run:

./locker

now open http://localhost:8042/ in your browser!

To get started using the system, navigate to the 'Services' menu item, select an account to connect, and follow the instructions to start using that connector with your locker.

The Detailed Way

If you encounter errors in "the fast way", or if you want to go through the process of setting everything up manually, check out the detailed set up instructions.

What are these things?

  • Connectors - A service that knows how to connect to and sync data with a place where I have data about myself, such as an account on a site or service, or in some desktop app, on my phone, or even from a device.
  • Collections - My data from the many different sources gets organized into common collections, such as places, contacts, messages, statuses, links, etc.
  • Apps - Once my data is in my locker I need apps that do useful or fun things for me, with the ability to control where my data goes and not have to give up access to my online accounts.

Once I "install" them in my locker (giving them some working space, a local port, and some config), I can browse to them where they provide their own instructions/steps (for now, it's early yet and pretty manual). To learn a bit more about the innards, I can install and run the Dev Docs app. :)

We need TONS of help and it's welcomed across the board, particularly in adding and advancing more of the connectors, just don a hard-hat and dig in, all patches welcomed, personal data FTW!

I am the platform.