orbit-textui's Introduction

orbit-textui

Prototype terminal client for Orbit

Status: The project hasn't been updated in a long time and is definitely out of date. We would love help, if you're interested in contributing!

Hats off to irssi, inseparable since 2001.

Built with the following packages:

orbit-core - Core Orbit communication library.
orbit-db - Serverless, p2p database that orbit-core uses to store its data.
js-ipfs - A new p2p hypermedia protocol for content-addressed storage.

Run

Get the source code and install dependencies:

git clone https://github.com/orbitdb/orbit-textui.git
cd orbit-textui
npm install

Start the program:

npm start

Or instead of npm start, run the following to specify your chat name:

node index <nickname>

Contribute

We 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 us on Gitter, or in the issues section.

We also have regular community calls, which we announce in the issues in the @orbitdb welcome repository. Join us!

For specific guidelines for contributing to this repository, check out the Contributing guide. For more on contributing to OrbitDB in general, take a look at the @OrbitDB welcome repository. Please note that all interactions in @OrbitDB fall under our Code of Conduct.