MCPcopy Index your code
hub / github.com/MichaelMure/Arbore

github.com/MichaelMure/Arbore @v0.3.2

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.3.2 ↗ · + Follow
545 symbols 1,251 edges 228 files 9 documented · 2%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

License: GPL v3 Gitter chat codebeat badge Codacy Badge Build Status GitHub (pre-)release

Arbore is a peer-to-peer file sharing application with the following caracteristics: - targeted for private/low diffusion data between people that know each-others. Main use case: friends want to share between each-others their holidays pictures. - low friction: it should be as easy as possible - encryption should be used to maintain privacy and to control the diffusion of the data

This application is build on top of IPFS.

----> Download it here ! <----

identity creation

login

sharing

shares

chat

GETTING STARTED

  1. Clone or download this repository
  2. run npm install to install all the dependencies.
  3. run npm run dev to launch the developement version

Installation package will be provided later.

ROADMAP

Version 1 (minimal first version)

  • profile management
  • basic contact management (adding with a hash)
  • contact suggestion and privacy settings
  • targeted sharing (notification and download)
  • basic 1 to 1 chat

Version 2 (encryption and chat)

  • encryption (IPFS is currently working on encryption)

Version 3

contact-related features:

  • public sharing and contact following (kind of like Twitter)
  • contact blocking (for abuse)
  • contact groups
  • contact management: mitigation strategy (maintaining your contacts files online because you like them)
  • profile "migration" with notification of contacts
  • on-demand custom app packaging with a first contact for extra-simple onboarding

content-related features:

  • reliable and efficient download status tracking (when available; details ipfs/go-ipfs#3866)
  • reception confirmation
  • content: re-share
  • better share description, maybe with markdown ?
  • content: fancy share's content visualization (for instance, for pictures with a slideshow or carousel)
  • internationalization

misc:

  • mobile version using react native
  • enhanced chat (offline, history, group chat, encryption ...) maybe using orbit.chat
  • ability to close the main windows while still having the app running + system tray icon with stats

License

You can check out the full license here

This project is licensed under the terms of the GPL v3 license.

Questions/feedback (or just want to help out?)

Every little bit of help counts!

If you want to build something awesome or help out in any other way, please contact us :)

Extension points exported contracts — how you extend this code

express$RouteMethodType (Interface)
(no doc)
flow-typed/npm/express_v4.x.x.js

Core symbols most depended-on inside this repo

waitForIpfsReady
called by 21
app/ipfs/ipfsRenderer.js
findContactInDirectory
called by 13
app/models/ContactList.js
create
called by 12
app/models/Share.js
findContactInPool
called by 8
app/models/ContactList.js
getLoginStore
called by 6
app/store/index.js
createProtocol
called by 5
app/ipfs/createProtocol.js
reset
called by 4
app/components/common/AvatarEditor.js
strContain
called by 4
app/utils/strContain.js

Shape

Function 223
Method 173
Class 148
Interface 1

Languages

TypeScript100%

Modules by API surface

app/actions/contactList.js22 symbols
app/models/Share.js18 symbols
app/models/ShareList.js17 symbols
app/actions/shareList.js15 symbols
app/models/ContactList.js14 symbols
flow-typed/npm/express_v4.x.x.js13 symbols
app/models/Profile.js13 symbols
app/models/IpfsDirectory.js12 symbols
app/models/Contact.js12 symbols
app/ipfs/ipfsMonoProcess.js11 symbols
app/ipfs/ipfsMain.js11 symbols
app/components/common/AvatarEditor.js11 symbols

For agents

$ claude mcp add Arbore \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page