Socket
Socket
Sign inDemoInstall

docloop

Package Overview
Dependencies
84
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    docloop

Service to convert annotations on one platform into issue on another.


Version published
Weekly downloads
9
increased by50%
Maintainers
1
Install size
5.34 MB
Created
Weekly downloads
 

Readme

Source

docloop

docloop turns feedback into tasks,
converting online annotations of a document into issues in the author's bug tracking system.

For each platform you want to use with it you will need a separate adapter. The core module does not come with any real adapters, but here's two of them to install additionally:

  • PaperhiveAdapter
  • GithubAdapter

With these two adapters in charge, docloop converts comments and replies of Paperhive documents into Github issues.

Check the example app at https://app.docloop.net

The core module and the two adapters are documented here: docloopDocs

Requirements

docloop is built using node and published using npm. To install it you need Node.JS. To actually run it you will also need a MongoDB to connect to.

Quick start

First of all get the core module:

npm install docloop

Setup up a MongoDB and use its credentials in the following minimal example:

var docloop         = require("docloop"),
    DocloopCore     = docloop.DocloopCore,
    DocloopAdapter  = docloop.DocloopAdapter,
    DocloopEndpoint = docloop.DocloopEndpoint

var docloopCore     = new DocloopCore({
                        port:     7777,
                        sessionSecret:  'abc',
                        db:{
                          name:     "your_db_name",
                          port:     27010,          //or wherever your db is running
                          user:     "your_db_user", //if authentication is required
                          pass:     "your_db_pass", //if authentication is required
                          address:  "127.0.0.1"     //or wherever your db is running
                        }
                      })

docloopCore
.use(DocloopAdapter,{
  id:       'custom-source-adapter',
  type:     'source',
  endpointClass:  DocloopEndpoint,
})
.use(DocloopAdapter,{
  id:       'custom-target-adapter',
  type:     'target',
  endpointClass:  DocloopEndpoint,
})
.run()

With this docloop is running on localhost:7777. Communication works via http requests.

To actually see something you should get the client: docloopClient

Clone the repository and serve the SRC-directory (will improve on that in the future). Set the backendUrl in app.js or config.js to localhost:7777 and the app should work with the exmaple code above.

Alas, the example code doesn't do much. The DocloopAdapter is only a generic base class for custom adapters. It doesn't really do anything on its own. In Order to have the example do something useful you might want to install the above mentioned adpaters or write your own adapter class.

Using the paperhive-adapter is straight forward. The github-adapter however requires you to setup a GithubApp beforehand.

The example app uses the code from docloopBackend.

Check the documenation for configuration options of the two adapters. There's also a tutorial for a more complex example with custom adapters.

Keywords

FAQs

Last updated on 27 Aug 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc