UNPKG

glitter-sdk-js

Version:

A light client which talks to your Glitter over Http

133 lines (118 loc) 5.79 kB
<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Installation &mdash; glitter-sdk-js documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="_static/tabs.css" type="text/css" /> <!--[if lt IE 9]> <script src="_static/js/html5shiv.min.js"></script> <![endif]--> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/jquery.js"></script> <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Quickstart" href="quickstart.html" /> <link rel="prev" title="Welcome to glitter-sdk-js’s documentation!" href="index.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="index.html" class="icon icon-home"> glitter-sdk-js </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul class="current"> <li class="toctree-l1"><a class="reference external" href="https://glitterprotocol.io/">← glitternetwork</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul> <li class="toctree-l2"><a class="reference internal" href="#installing-with-npm">Installing with NPM</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li> <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li> <li class="toctree-l1"><a class="reference internal" href="libref.html">Library Reference</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="index.html">glitter-sdk-js</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li>Installation</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/install.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="installation"> <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this heading"></a></h1> <p>This tutorial walks you through how to set up <a class="reference external" href="https://github.com/glitternetwork/glitter-sdk-py">glitter-sdk-js</a> for local development.</p> <p>The glitter Node Driver depends on:</p> <ol class="arabic simple"> <li><p>Node v14.15.0+</p></li> <li><p>A recent Node version of NPM</p></li> </ol> <section id="installing-with-npm"> <h2>Installing with NPM<a class="headerlink" href="#installing-with-npm" title="Permalink to this heading"></a></h2> <p>We recommend using NPM to install glitter_sdk on all platforms:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ npm install glitter-sdk-js </pre></div> </div> <p>To get a specific version of glitter:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ npm install glitter-sdk-js@0.1.0 </pre></div> </div> <p>To upgrade using npm:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ npm update glitter-sdk-js </pre></div> </div> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="index.html" class="btn btn-neutral float-left" title="Welcome to glitter-sdk-js’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="quickstart.html" class="btn btn-neutral float-right" title="Quickstart" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>&#169; Copyright 2022, glitter.</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>