Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 2.42 KB

README.md

File metadata and controls

62 lines (40 loc) · 2.42 KB
Raw

TODO

  • finish the replication. it creates the stores but not sync

Welcome

to ELMO - Efficient Link Management and Organizer

Elmo is available for chromium based browser. This is just a proof of concept to show the real world use case of IPFS and orbitDB. I hope you will give it a go and you will like it.

It is fairly stable and sometimes slow with replication, that is due to the mechanics of the underlying layer, OR it could be just me and my programming. In any case feel free to contribute with the code or the advice. All are much appreciated.

Diagram of what we want to have

graph LR
    link[Save Link from the web] --> coll[Add to collection] --> share{share}
    share -- Full sync --> me[full sync across devices]
    link --> share
    link -- ipfs -->  offline[Have the link content offline]
    link --> online[For online view]
    share -- Collaboration with ACL --> friend[With a friend]
    friend -- Collaboration with ACL --> share
Loading

What will this do to my Browser

ELMO will spin up the IPFS and OrbitDB instance in your browser, connect to the public web and listen to the connections if you wish to replicate the links and collections across your devices.

Security and encryption

Data is NOT encrypted, it will be eventually, check out the issue here which is good place to see the progress.

From the security point fo view, all the data is kept in sandbox environment which is available only to the extension itself. The connection to the public is only there for its discovery, not for sending any data.

NOTE:::::: There is a built extension which is ready for download, unfortunately it is not verified from google or brave, thus it might not work. Recommended way is to build it yourself.

Get started

Commands below will get you started with the development of the extension and give you a bundle which you can load into your browser.

Requirements are:

When you all that run the commands from the terminal.

git clone https://gitlab.com/woss_io/elmo.git
cd elmo
yarn
yarn dev

Now you are ready to load the extension. Check out this to see the demo...

intro