README.md

Ripple Trade client

Overview

The Ripple Trade client is an open-source GUI for the Ripple network that facilitates the peer-to-peer exchange of any store of value. It’s the only platform where you can trade between stores of value spanning fiat, cryptocurrencies, commodities, and unusual assets like pre-1965 silver dimes.

Ripple Labs is the core team behind the project. For more information on the Ripple protocol, please visit our wiki.

We would love to have folks contribute! Check out our bounties here.

Ripple Trade is available at www.rippletrade.com.

Getting Started

Install Dependencies

Install Node.js, Gulp, Git and Python 2 if you haven't already.

Install bower by running sudo bower install --allow-root.

Fork and clone the ripple-client repository and run npm install.

Create a new config.js file and copy/paste from config-example.js into the same directory.

Build

Run 'gulp' in your command line for development.

Run 'gulp dist' for the production ready client.

Your web client is in the 'build/dist/' directory.

Target backend

By default, the ripple.txt file is pointed at the staging server. This means you will only be able to log in on your dev environment with an account created on staging.rippletrade.com.

If you want to point your environment at the production server:

• set the authinfo_url in ripple.txt (in the root of the repo directory) to: https://id.ripple.com/v1/authinfo (make sure to rebuild + clear browser cache)
• set the activate_link property in config.js to https://rippletrade.com/#/register/activate

Directory Layout

build/         -->    compiled files
deps/          -->    client dependencies
docs/          -->    documentation
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

Testing

Stay tuned...

APIs and Libraries used by Ripple Trade client

• blobvault
• ripple-lib
• ripple-vault-client

Reporting Bugs

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.

Contributing

Ripple Labs uses Jira to track issues. We highly encourage our community to contribute but please look at our Development Policy and our CONTRIBUTING.md file before submitting a pull request.

We are also using Bountysource allowing our community to request bids from developers to solve open-source issues!

Community

Keep track of development and community news.

• Read and subscribe to the The Official Ripple Blog.
• Follow @Ripple on Twitter
• Follow @RippleLabs on Twitter
• Like Ripple Labs on Facebook
• Subscribe to @Ripple on Reddit
• Subscribe to the Ripple user community on Reddit
• Have a question that's not a feature request or bug report? Send a message to support@ripple.com
• Chat directly with our engineers! Join us here.

More Information

https://ripple.com/wiki/Ripple_Client

License

https://github.com/ripple/ripple-client/blob/develop/LICENSE