justmoon / ripple-client

A UI for the Ripple payment network built using web technologies

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Ripple Client

This is a general purpose Ripple client in JavaScript.

Directory structure

  • build/ Compiled files
  • src/ Source code
  • src/js/client Client classes
  • src/js/entry Entry points for the various client versions
  • src/js/util Various static, stateless utility functions
  • tools/ Tools used in the build process

Installation

  1. Install node.js and npm.

  2. Install Grunt.

     $ sudo npm install -g grunt-cli
    
  3. Install Ripple Client.

     $ git clone https://github.com/ripple/ripple-client ./ripple-client
     $ cd ripple-client
     $ npm install
    
  4. Create your config.js file

     $ cp src/js/config-example.js src/js/config.js
    
  5. Create your config.json file

     $ cp config-example.json config.json
    

Build

Run the following command to build the client.

$ grunt

Access the web client in build/bundle/web/. Use index_debug.html for development. Grunt watch will run preprocess only for index_debug.html.

Travis CI

Follow the build status and tests at http://travis-ci.org/ripple/ripple-client

Testing Locally

Run the following command to run the tests once.

./node_modules/.bin/karma start test/karma.conf.js --single-run

Or run Karma in the background and listen to changes in /test

./node_modules/.bin/karma start test/karma.conf.js

Bug tracker

Have a bug or a feature request? Please create a new issue. Before opening any issue, please search for existing issues and read the Issue Guidelines, written by Nicolas Gallagher.

Community

Keep track of development and community news.

More information

About

A UI for the Ripple payment network built using web technologies

License:ISC License