Neatly Positioned Magazines

    reddcore

    0.1.40 • Public • Published

    Reddcore

    Build Status Coverage Status

    A pure, powerful core for your Reddcoin project.

    Reddcore is a complete, native interface to the Reddcoin network, and provides the core functionality needed to develop apps for Reddcoin.

    Principles

    Reddcoin is a powerful new peer-to-peer platform for the next generation of financial and social technology. The decentralized nature of the Reddcoin network allows for highly resilient Reddcoin infrastructure, and the developer community needs reliable, open-source tools to implement Reddcoin apps and services.

    Reddcore unchains developers from fallible, centralized APIs, and provides the tools to interact with the real Reddcoin network.

    Get Started

    Reddcore runs on node, and can be installed via npm:

    npm install reddcore
    

    It is a collection of objects useful to Reddcoin applications; class-like idioms are enabled viaSoop. In most cases, a developer will require the object's class directly. For instance:

    var reddcore = require('reddcore');
    var Address = reddcore.Address;
    var Transaction = reddcore.Transaction;
    var PeerManager = reddcore.PeerManager;

    Examples

    Examples are provided here Build the examples by installing and running gulp:

    npm install -g gulp
    gulp
    

    Javascript files available at /examples folder.

    Security

    Please use at your own risk.

    Reddcore is still under heavy development and not quite ready for "drop-in" production use. If you find a security issue, please email ren@reddcoin.com

    Contributing

    Reddcore needs some developer love. Please send pull requests for bug fixes, code optimization, and ideas for improvement.

    Browser support

    Building the browser bundle

    To build Reddcore full bundle for the browser (this is automatically executed after you run npm install):

    node browser/build.js -a
    

    This will generate a browser/bundle.js file which you can include in your HTML to use Reddcore in the browser.

    Example browser usage

    From example/simple.html

    <!DOCTYPE html>
    <html>
      <body>
        <script src="../browser/bundle.js"></script> 
        <script>
          var reddcore = require('reddcore');
          var Address = reddcore.Address;
          var a = new Address('RqAahY1pTk1q417ALF4ScYGLWthphAGaHW');
          console.log('RqAahY1pTk1q417ALF4ScYGLWthphAGaHW is valid? '+a.isValid());
        </script> 
      </body>
    </html>

    You can check a more complex usage example at examples/example.html.

    Generating a customized browser bundle

    To build the main Reddcore bundle, run:

    node browser/build.js -m
    

    To build all features into the Reddcore bundle (which will lead to a large file size), run:

    node browser/build.js -a
    

    To generate a customized Reddcore bundle, you can specify which submodules you want to include in it with the -s option:

    node browser/build.js -s lib/Transaction,lib/Address
    

    This will generate a browser/bundle.js containing only the Transaction and Address class, with all their dependencies. Use this option if you are not using the whole Reddcore library, to optimize the bundle size, script loading time, and general resource usage.

    Tests

    Run tests in node:

    mocha
    

    Or generate tests in the browser:

    grunt shell
    

    And then open test/index.html in your browser.

    To run the code coverage report:

    npm run-script coverage
    

    And then open coverage/lcov-report/index.html in your browser.

    License

    Bitcore Code released under the MIT license.

    Copyright 2013-2014 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.

    Bitdeli Badge

    Install

    npm i reddcore

    DownloadsWeekly Downloads

    1

    Version

    0.1.40

    License

    MIT

    Last publish

    Collaborators

    • laudney