What is AloneWeb?

AloneWeb aims to deliver a unified, seamless development experience influenced by Ethereum's [Web3] implementation. We have taken the core ideas and expanded upon it to unlock the functionality of ALONE's unique feature set along with offering new tools for integrating DApps in the browser, Node.js and IoT devices.

Compatibility

• Version built for Node.js v6 and above
• Version built for browsers with more than 0.25% market share

You can access either version specifically from the dist folder.

AloneWeb is also compatible with frontend frameworks such as:

• Angular
• React
• Vue.

You can also ship AloneWeb in a Chrome extension.

Installation

Node.js

npm install aloneweb

or

yarn add aloneweb

Browser

First, don't use the release section of this repo, it has not updated in a long time.

Then easiest way to use AloneWeb in a browser is to install it as above and copy the dist file to your working folder. For example:

cp node_modules/aloneweb/dist/AloneWeb.js ./js/aloneweb.js

so that you can call it in your HTML page as

<script src="./js/aloneweb.js"><script>

Your local private network for heavy testing

You can set up your own private network, running Alone Quickstart. To do it you must install Docker and, when ready, run a command like

docker run -it --rm \
  -p 9090:9090 \
  -e "defaultBalance=100000" \
  -e "showQueryString=true" \
  -e "showBody=true" \
  -e "formatJson=true" \
  --name alone \
  alonetools/quickstart

Creating an Instance

First off, in your javascript file, define AloneWeb:

const AloneWeb = require('aloneweb')

The easiest way to instantiate aloneWeb is to run

const aloneWeb = new AloneWeb({
    fullHost: 'http://ip:port',
    solidityNode: 'http://ip:port'
    eventServer: 'http://ip:port',
    privateKey: '...'
})

but you can continue to use the old way:

const aloneWeb = new AloneWeb(fullNode, solidityNode, eventServer, privateKey)


## A full example

The better way to understand how to work with Alone is to clone the [MetaCoin example]

## Contributions

In order to contribute you can

* fork this repo and clone it locally
* install the dependencies — `npm i`
* do your changes to the code
* build the AloneWeb dist files — `npm run build`
* run a local private network using Alone Quickstart
* run the tests — `npm test:node`
* push your changes and open a pull request