orbitdb
/
orbit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Standardize README 

As much as possible. Didnt use an install or usage section, as this is a different project, although Im not sure that makes sense here.

This is an update of #35, which wasnt merged and was so diverged to be obsolete
master
Richard Littauer 2016-10-05 11:45:17 -04:00
parent 8018973261
commit fad6d7d703
1 changed files with 64 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
README.md
View File

@ -1,5 +1,11 @@
# Orbit
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/project-orbit-blue.svg?style=flat-square)](http://ipfs.io/)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
[![Project Status](https://badge.waffle.io/haadcode/orbit.svg?label=In%20Progress&title=In%20Progress)](http://waffle.io/haadcode/orbit)
[![CircleCI Status](https://circleci.com/gh/haadcode/orbit.svg?style=shield&circle-token=158cdbe02f9dc4ca4cf84d8f54a8b17b4ed881a1)](https://circleci.com/gh/haadcode/orbit)
> A distributed, peer-to-peer chat application built on [IPFS](http://ipfs.io)
**NOTE!** *Currently only the Electron (Desktop) version works. We're working to fix the Browser version (js-ipfs)*
@ -8,6 +14,25 @@
<img src="https://raw.githubusercontent.com/haadcode/orbit/master/screenshots/screenshot7%202016-09-02.png" width="50%">
<img src="https://raw.githubusercontent.com/haadcode/orbit/master/screenshots/screenshot6%202016-04-17.png" width="50%">
## Table of Contents
- [Project Status](#project-status)
- [Run](#run)
- [Live Demo](#live-demo)
- [Desktop](#desktop)
- [Browser](#browser)
- [Development](#development)
- [Requirements](#requirements)
- [Get the source code](#get-the-source-code)
- [Install dependencies](#install-dependencies)
- [Run Tests](#run-tests)
- [Browser app development](#browser-app-development)
- [Build](#build)
- [Desktop app development](#desktop-app-development)
- [Build](#build-1)
- [Contributing](#contributing)
- [License](#license)
## Project Status
**Status:** *In active development*
@ -16,10 +41,7 @@
Check the project's [roadmap](https://github.com/haadcode/orbit/blob/master/ROADMAP.md) to see what's happening at the moment and what's planned next.
[![Project Status](https://badge.waffle.io/haadcode/orbit.svg?label=In%20Progress&title=In%20Progress)](http://waffle.io/haadcode/orbit)
[![CircleCI Status](https://circleci.com/gh/haadcode/orbit.svg?style=shield&circle-token=158cdbe02f9dc4ca4cf84d8f54a8b17b4ed881a1)](https://circleci.com/gh/haadcode/orbit)
See also [CHANGELOG](https://github.com/haadcode/orbit/blob/master/CHANGELOG.md) for what's new!
See also the [CHANGELOG](https://github.com/haadcode/orbit/blob/master/CHANGELOG.md) for what's new!
If you would like to participate in designing what Orbit is as a product, please join us in [Product Design for Orbit](https://github.com/haadcode/orbit/issues/149) issue.
@ -29,32 +51,26 @@ Orbit can be run either in a browser or as a native desktop application. The bro
***Please note that Orbit is not secure at the moment!***
#### Live Demo
### Live Demo
[http://orbit.libp2p.io/](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
### Desktop
##### Requirements
- Node.js v6.x.x
- npm v3.x.x
##### Install and Run
```
```sh
git clone https://github.com/haadcode/orbit.git
cd orbit
npm install
npm start
```
#### Browser
### Browser
*Chrome is recommended to run Orbit in the browser.*
```
```sh
git clone https://github.com/haadcode/orbit.git
cd orbit
npm install
@ -63,29 +79,36 @@ npm start
## Development
#### Requirements
- Node.js v6.x.x
- npm v3.x.x
### Requirements
- [Node.js v4.x.x](http://nodejs.org/)
- [npm](https://npmjs.com)
- g++, gcc, make (for building native modules)
- python 2 (for building, some native modules need it, node-fibers perhaps?)
#### Get the source code
The following npm modules must be installed globally: [grunt-cli](https://www.npmjs.com/package/grunt-cli), [mocha](https://www.npmjs.com/package/mocha), [electron-prebuilt](https://www.npmjs.com/package/electron-prebuilt). These can be installed by running:
```sh
npm i -g grunt-cli mocha electron-prebuilt
```
### Get the source code
```sh
git clone https://github.com/haadcode/orbit.git
cd orbit/
```
#### Install dependencies
```
### Install dependencies
```sh
npm install
```
#### Run Tests
### Run Tests
*Note! Running the tests requires a running `redis-server`. If you don't have it installed, see installation instructions for [OSX](http://jasdeep.ca/2012/05/installing-redis-on-mac-os-x/) or [Linux](http://redis.io/topics/quickstart)*
```
```sh
npm test
```
@ -93,7 +116,7 @@ npm test
**NOTE!** *This is currently not working as described. We're working to fix it.*
```
```sh
cd client/
npm install
npm run dev
@ -101,8 +124,9 @@ npm run dev
This will open webpack dev-server at [http://localhost:8000/webpack-dev-server](http://localhost:8000/webpack-dev-server).
##### Build
```
#### Build
```sh
cd client/
npm install
npm run build
@ -110,25 +134,27 @@ npm run build
This will create `client/dist` directory which contains all the files needed to distribute the Orbit browser application.
#### Desktop app development
### Desktop app development
First, start the desktop app in developer mode:
```
```sh
npm run dev:electron
```
Then, start the UI development environment:
```
```sh
cd client/
npm install
npm run dev
```
##### Build
#### Build
*Run this is in project's root directory, not in `client/`.*
```
```sh
npm run build
```
@ -160,9 +186,12 @@ See [API documentation](https://github.com/haadcode/orbit/blob/master/API.md) fo
- [getFile(hash)](#getfilehash)
- [getDirectory(hash)](#getdirectoryhash)
## 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](https://twitter.com/haadcode) or on IRC #ipfs on Freenode, or in the comments of the [issues section](https://github.com/haadcode/orbit/issues).
I 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](https://twitter.com/haadcode) or on IRC #ipfs on Freenode, or in the comments of the [issues section](https://github.com/haadcode/orbit/issues).
Good place to start is to take a look at the ["help wanted"](https://github.com/haadcode/orbit/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+sort%3Areactions-%2B1-desc) issues or the project's [status board](https://waffle.io/haadcode/orbit).
A good place to start are the issues labelled ["help wanted"](https://github.com/haadcode/orbit/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+sort%3Areactions-%2B1-desc) or the project's [status board](https://waffle.io/haadcode/orbit).
## License
[MIT](LICENSE) © haadcode