Skip to content

Distributed, serverless, peer-to-peer chat application on IPFS

License

Notifications You must be signed in to change notification settings

passstab/orbit

 
 

Repository files navigation

Orbit

A distributed, peer-to-peer chat application built on IPFS

NOTE! Currently only the Electron (Desktop) version works. We're working to fix the Browser version (js-ipfs)

Project Status

Status: In active development

Check the project's roadmap to see what's happening at the moment and what's planned next.

Project Status CircleCI Status

See also CHANGELOG for what's new!

Run

Orbit can be run either in a browser or as a native desktop application. The browser application uses js-ipfs implementation of IPFS. The desktop version uses the go-ipfs implementation of IPFS together with Electron.

Please note that Orbit is not secure at the moment!

Live Demo

http://orbit.libp2p.io/

The live demo is an old version of Orbit. It is recommended to follow the instructions below to run the latest version.

Desktop

Requirements
  • Node.js v6.x.x
  • npm v3.x.x
Install and Run
git clone https://github.com/haadcode/orbit.git
cd orbit
npm install
npm start

Browser

Chrome is recommended to run Orbit in the browser.

git clone https://github.com/haadcode/orbit.git
cd orbit
npm install
npm start

Development

Requirements

  • Node.js v6.x.x
  • npm v3.x.x
  • g++, gcc, make (for building native modules)
  • python 2 (for building, some native modules need it, node-fibers perhaps?)

Get the source code

git clone https://github.com/haadcode/orbit.git
cd orbit/

Install dependencies

npm install

Run Tests

Note! Running the tests requires a running redis-server. If you don't have it installed, see installation instructions for OSX or Linux

npm test

Browser app development

cd client/
npm install
npm run dev

This will open webpack dev-server at http://localhost:8000/webpack-dev-server.

Build
cd client/
npm install
npm run build

This will create client/dist directory which contains all the files needed to distribute the Orbit browser application.

Desktop app development

First, start the desktop app in developer mode:

npm run dev:electron

Then, start the UI development environment:

cd client/
npm install
npm run dev
Build

Run this is in project's root directory, not in client/.

npm run build

The builds are in dist/.

Contributing

Would be happy to accept PRs! If you want to work on something, it'd be good to talk beforehand to make sure nobody else is working on it. You can reach me on Twitter @haadcode or on IRC #ipfs on Freenode, or in the comments of the issues section.

Good place to start is to take a look at the "help wanted" issues or the project's status board. 0

About

Distributed, serverless, peer-to-peer chat application on IPFS

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 78.2%
  • HTML 12.1%
  • CSS 9.5%
  • Shell 0.2%