mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 19:55:54 +00:00
rippleapi quickstart - added, incomplete
This commit is contained in:
mDuo13
258
rippleapi_quickstart.html
Normal file
258
rippleapi_quickstart.html
Normal file
@@ -0,0 +1,258 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<meta name="viewport" content="width=device-width">
|
||||
|
||||
<title>RippleAPI Quick Start Guide - Ripple Developer Portal</title>
|
||||
|
||||
<!-- favicon -->
|
||||
<link rel="icon" href="favicon.ico" type="image/x-icon">
|
||||
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
|
||||
|
||||
<!-- jQuery -->
|
||||
<script src="vendor/jquery-1.11.1.min.js"></script>
|
||||
|
||||
<!-- Bootstrap -->
|
||||
<link href="css/bootstrap.min.css" rel="stylesheet">
|
||||
<script src="js/bootstrap.min.js"></script>
|
||||
|
||||
|
||||
<!-- Flatdoc theme -->
|
||||
<link href='vendor/flatdoc/v/0.8.0/theme-white/style.css' rel='stylesheet'>
|
||||
<script src="vendor/flatdoc/v/0.8.0/theme-white/script.js"></script>
|
||||
|
||||
<!-- syntax highlighting -->
|
||||
<link rel="stylesheet" href="vendor/docco.min.css">
|
||||
<script src="vendor/highlight.min.js"></script>
|
||||
|
||||
<!-- syntax selection js -->
|
||||
<script src="js/multicodetab.js"></script>
|
||||
<!-- Markdown content already parsed+included; just do the code tab stuff -->
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
</script>
|
||||
|
||||
<script src="js/expandcode.js"></script>
|
||||
<script src="js/fixsidebarscroll.js"></script>
|
||||
|
||||
<!-- Custom Stylesheets -->
|
||||
<link href="font/fonts.css" rel="stylesheet" type="text/css" />
|
||||
<link href="css/main.css" rel="stylesheet" />
|
||||
<link href="css/custom.css" rel="stylesheet" />
|
||||
|
||||
<link rel="shortcut icon" href="favicon.ico?v=2" type="image/x-icon" />
|
||||
<link rel="icon" href="favicon.ico?v=2" type="image/x-icon" />
|
||||
|
||||
|
||||
</head>
|
||||
<body class='no-literate'>
|
||||
<div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
|
||||
<div class="container">
|
||||
<div class="navbar-header">
|
||||
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
|
||||
<span class="sr-only">Toggle navigation</span>
|
||||
<span class="icon-bar"></span>
|
||||
<span class="icon-bar"></span>
|
||||
<span class="icon-bar"></span>
|
||||
</button>
|
||||
<a class="navbar-brand" href="./"><img class="small_logo" src="assets/img/ripple_logo_small.png"></a>
|
||||
</div>
|
||||
<div class="navbar-collapse collapse">
|
||||
<ul class="nav navbar-nav">
|
||||
<li class="dropdown">
|
||||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Concepts <span class="caret"></span></a>
|
||||
<ul class="dropdown-menu" role="menu">
|
||||
<li><a href="paths.html">Paths</a></li>
|
||||
<li><a href="fees.html">Fees (Disambiguation)</a></li>
|
||||
<li><a href="transfer_fees.html">Transfer Fees</a></li>
|
||||
<li><a href="tx-cost.html">Transaction Cost</a></li>
|
||||
<li><a href="fee-voting.html">Fee Voting</a></li>
|
||||
<li><a href="reserves.html">Reserves</a></li>
|
||||
<li><a href="freeze.html">Freeze</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown">
|
||||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorials <span class="caret"></span></a>
|
||||
<ul class="dropdown-menu" role="menu">
|
||||
<li><a href="rippleapi_quickstart.html">RippleAPI Quick Start Guide</a></li>
|
||||
<li><a href="rippled-setup.html">rippled Setup</a></li>
|
||||
<li><a href="reliable_tx.html">Reliable Transaction Submission</a></li>
|
||||
<li><a href="gateway_guide.html">Gateway Guide</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown">
|
||||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">References <span class="caret"></span></a>
|
||||
<ul class="dropdown-menu" role="menu">
|
||||
<li><a href="rippled-apis.html">rippled</a></li>
|
||||
<li><a href="transactions.html">Transactions</a></li>
|
||||
<li><a href="ripple-ledger.html">Ledger Format</a></li>
|
||||
<li><a href="data_api_v2.html">Ripple Data API v2</a></li>
|
||||
<li><a href="rippleapi.html">RippleAPI</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown">
|
||||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">API Tools <span class="caret"></span></a>
|
||||
<ul class="dropdown-menu" role="menu">
|
||||
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
|
||||
<li><a href="data-api-v2-tool.html">Data API v2 Tool</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown">
|
||||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <span class="caret"></span></a>
|
||||
<ul class="dropdown-menu" role="menu">
|
||||
<li><a href="https://forum.ripple.com/viewforum.php?f=2">Forums</a></li>
|
||||
<li><a href="https://www.bountysource.com/teams/ripple/bounties">Bounties</a></li>
|
||||
<li><a href="https://ripplelabs.atlassian.net/">Bug Tracking</a></li>
|
||||
<li><a href="https://ripple.com/category/dev-blog/">Dev Blog</a></li>
|
||||
<li><a href="https://ripple.com/press-releases/">Press Center</a></li>
|
||||
<li><a href="https://ripple.com/brand-guidelines/">Brand Guidelines</a></li>
|
||||
</ul>
|
||||
<li><a href="https://github.com/ripple/ripple-dev-portal" title="GitHub">Site Source</a></li>
|
||||
</ul>
|
||||
</div><!--/.nav-collapse -->
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
if (window.location.host.indexOf("github.io") > -1) {
|
||||
document.write("<div style='background-color:red; color:white; position:fixed; top: 50px; right: 150px; padding: 10px 20px;'>DRAFT</div>");
|
||||
}
|
||||
</script>
|
||||
<div class='wrapper'>
|
||||
<div class='content-root'>
|
||||
<div class='menubar'>
|
||||
<div class='menu section' role='flatdoc-menu'>
|
||||
<script type="text/javascript" src="js/jquery.gensidebar.js"></script>
|
||||
<script type="text/javascript">
|
||||
|
||||
</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class='content'>
|
||||
<h1 id="rippleapi-quick-start-guide">RippleAPI Quick Start Guide</h1>
|
||||
<p>This tutorial guides you through the basics of building a simple Ripple-connected application using <a href="http://nodejs.org/">Node.js</a> and <a href="rippleapi.html">RippleAPI</a>, a simple JavaScript API for accessing the Ripple Consensus Ledger.</p>
|
||||
<h1 id="environment-setup">Environment Setup</h1>
|
||||
<p>The first step to using RippleAPI successfully is setting up your development environment.</p>
|
||||
<h2 id="install-nodejs-and-npm">Install Node.js and npm</h2>
|
||||
<p>RippleAPI is built as an application for the Node.js runtime environment, so the first step is getting Node.js installed. Specifically, RippleAPI requires Node.js version 0.12, version 4.x, or higher.</p>
|
||||
<p>This step depends on your operating system. We recommend <a href="https://nodejs.org/en/download/package-manager/">the official instructions for installing Node.js using a package manager</a> for your operating system. If the packages for Node.js and <code>npm</code> (Node Package Manager) are separate (this includes Arch Linux, CentOS, Fedora, and RHEL), you should make sure to install both.</p>
|
||||
<p>After you have installed Node.js, you can check whether it's installed by checking the version of the <code>node</code> binary from a commandline:</p>
|
||||
<pre><code>node --version
|
||||
</code></pre>
|
||||
<p>On some platforms, the binary is named <code>nodejs</code> instead:</p>
|
||||
<pre><code>nodejs --version
|
||||
</code></pre>
|
||||
<h2 id="use-npm-to-install-rippleapi-and-dependencies">Use NPM to install RippleAPI and dependencies</h2>
|
||||
<p>RippleAPI uses the newest version of JavaScript, ECMAScript 6 (also known as ES2015). In order to use the new features of ECMAScript 6, RippleAPI depends on <a href="https://babeljs.io">Babel-Node</a> and its ES2015 presets. Fortunately you can use <code>npm</code> to install RippleAPI and these dependencies all at once.</p>
|
||||
<h4 id="1-create-a-new-directory-for-your-project">1. Create a new directory for your project</h4>
|
||||
<p>For example, to create a folder called <code>my_ripple_experiment</code>:</p>
|
||||
<pre><code>mkdir my_ripple_experiment && cd my_ripple_experiment
|
||||
</code></pre>
|
||||
<p>Alternatively, you can <a href="https://help.github.com/articles/create-a-repo/">create a repo on GitHub</a> in order to share your work. After setting it up, <a href="https://help.github.com/articles/cloning-a-repository/">clone the repo</a> to your local machine and <code>cd</code> into that directory.</p>
|
||||
<h4 id="2-create-a-new-packagejson-file-for-your-project">2. Create a new <code>package.json</code> file for your project.</h4>
|
||||
<p>Here's a good template:</p>
|
||||
<pre><code>{
|
||||
"name": "my_ripple_experiment",
|
||||
"version": "0.0.1",
|
||||
"license": "UNLICENSED",
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
"ripple-lib": "*",
|
||||
"babel-cli": "^6.0.0",
|
||||
"babel-preset-es2015": "*"
|
||||
},
|
||||
"babel": {
|
||||
"presets": ["es2015"]
|
||||
},
|
||||
"devDependencies": {
|
||||
"eslint": "*"
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<p>This includes RippleAPI itself (<code>ripple-lib</code>), Babel (<code>babel-cli</code>), the ECMAScript 6 presets for Babel (<code>babel-preset-es2015</code>). It also has the optional add-on <a href="http://eslint.org/">ESLint</a> (<code>eslint</code>) for checking your code quality.</p>
|
||||
<h4 id="3-use-npm-to-install-the-dependencies">3. Use NPM to install the dependencies.</h4>
|
||||
<pre><code>npm install
|
||||
</code></pre>
|
||||
<p>This automatically installs all the dependencies defined in the <code>package.json</code> into the local folder <code>node_modules/</code>. (We recommend <em>not</em> using <code>npm -g</code> to install the dependencies globally.)</p>
|
||||
<p>The install process may take a while, and may end with a few warnings. The following warnings are benign, and do not indicate a real problem:</p>
|
||||
<pre><code>npm WARN optional Skipping failed optional dependency /chokidar/fsevents:
|
||||
npm WARN notsup Not compatible with your operating system or architecture: fsevents@1.0.6
|
||||
npm WARN ajv@1.4.10 requires a peer of ajv-i18n@0.1.x but none was installed.
|
||||
</code></pre>
|
||||
<h4 id="4-optional-tell-git-to-ignore-the-node-modules-folder">4. (Optional) Tell Git to ignore the <code>node_modules</code> folder.</h4>
|
||||
<p>If you are using Git to manage your repository, it's considered a good practice to omit the <code>node_modules</code> folder from the Git repo. Other people who check out your code can use <code>npm</code> to install the dependencies, and you don't have to keep the repo synchronized with changes to other people's code. Edit the <code>.gitignore</code> file and add the following line to it:</p>
|
||||
<pre><code>/node_modules/
|
||||
</code></pre>
|
||||
<p>Save and commit the changes:</p>
|
||||
<pre><code>git add .gitignore
|
||||
git commit -m "ignore node_modules"
|
||||
</code></pre>
|
||||
<h1 id="first-rippleapi-script">First RippleAPI Script</h1>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="footer">
|
||||
<div class="container">
|
||||
<div class="row">
|
||||
<div class="col-md-3">
|
||||
<h4>Documentation</h4>
|
||||
<ul class="footer_links">
|
||||
<li><a href="paths.html">Paths</a></li>
|
||||
<li><a href="fees.html">Fees (Disambiguation)</a></li>
|
||||
<li><a href="transfer_fees.html">Transfer Fees</a></li>
|
||||
<li><a href="tx-cost.html">Transaction Cost</a></li>
|
||||
<li><a href="fee-voting.html">Fee Voting</a></li>
|
||||
<li><a href="reserves.html">Reserves</a></li>
|
||||
<li><a href="freeze.html">Freeze</a></li>
|
||||
<li><a href="rippleapi_quickstart.html">RippleAPI Quick Start Guide</a></li>
|
||||
<li><a href="rippled-apis.html">rippled</a></li>
|
||||
<li><a href="rippled-setup.html">rippled Setup</a></li>
|
||||
<li><a href="transactions.html">Transactions</a></li>
|
||||
<li><a href="ripple-ledger.html">Ledger Format</a></li>
|
||||
<li><a href="reliable_tx.html">Reliable Transaction Submission</a></li>
|
||||
<li><a href="gateway_guide.html">Gateway Guide</a></li>
|
||||
<li><a href="data_api_v2.html">Ripple Data API v2</a></li>
|
||||
<li><a href="rippleapi.html">RippleAPI</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-md-3">
|
||||
<h4>Resources</h4>
|
||||
<ul class="footer_links">
|
||||
<li><a href="https://ripple.com/press-releases/">Press Center</a></li>
|
||||
<li><a href="https://ripple.com/brand-guidelines/">Brand Use and Guidelines</a></li>
|
||||
<li><a href="https://forum.ripple.com/viewforum.php?f=2">Forums</a></li>
|
||||
<li><a href="https://ripple.com/category/dev-blog/">Dev Blog</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-md-3">
|
||||
<h4>Ripple Projects</h4>
|
||||
<ul class="footer_links">
|
||||
<li><a href="https://www.rippletrade.com">Ripple Trade</a>
|
||||
<li><a href="https://www.ripplecharts.com">Ripple Charts</a>
|
||||
<li><a href="https://ripple.com/graph">Ripple Graph</a>
|
||||
<li><a href="http://codius.org/">Codius</a>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-md-3">
|
||||
<h4>Ripple Labs</h4>
|
||||
<ul class="footer_links">
|
||||
<li><a href="https://www.ripplelabs.com/wp-content/uploads/2014/10/ripple_labs_bylaws.pdf">Corporate Bylaws</a></li>
|
||||
<li><a href="https://www.ripplelabs.com/wp-content/uploads/2014/09/ripple_labs_code_of_conduct1.pdf">Code of Conduct</a></li>
|
||||
<li><a href="https://www.ripplelabs.com/team/">Team</a></li>
|
||||
<li><a href="https://www.ripplelabs.com/careers/">Careers</a></li>
|
||||
<li><a href="https://www.ripplelabs.com/investors/">Investors</a></li>
|
||||
<li><a href="https://www.ripplelabs.com/advisors/">Advisors</a></li>
|
||||
<li><a href="https://www.ripplelabs.com/xrp-distribution/">XRP Distribution</a></li>
|
||||
<li><a href="https://www.ripplelabs.com/contact/">Contact</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user