opencollab-lib

0.0.5 • Public • Published

OpenCollab Library

opencollab-lib is a library based on Yondon Fu's opencollab. It can be used in any NodeJs or Electron app.

Install

Two dependencies are currently needed to use the library:

  • TestRPC for the Ethereum RPC client
  • ipfs for the IPFS node

Then run npm install.

npm install -g ethereumjs-testrpc ipfs
npm install

Usage

Make sure TestRPC is running. Gas usage has not been addressed so it is likely necessary to run TestRPC with a high gas limit.

testrpc -l 1000000000

Start the IPFS node:

jsipfs daemon

Testing

First, make sure that TestRPC is running:

testrpc -l 1000000000

And since the library currently use babel to transpile its code, be sure to run npm run build before starting the tests:

npm run build
npm test

State of the Library

Below is a list of opencollab functionalities and their current state.

Command State Tests
init ‎✔ ‎✔
status ‎✔
issues
get-issue WIP
new-issue WIP
edit-issue (update-issue) x
delete-issue x
fork x x
merge-fork x x
pull-requests x x
get-pull-request x x
open-pull-request x x
close-pull-request x x
maintainers x x
add-maintainer x x
remove-maintainer x x
set-obsolete x x

Readme

Keywords

Package Sidebar

Install

npm i opencollab-lib

Weekly Downloads

5

Version

0.0.5

License

none

Unpacked Size

2.18 MB

Total Files

32

Last publish

Collaborators

  • mcormier