mirror of
https://github.com/status-im/web3.js.git
synced 2025-02-23 11:38:12 +00:00
47 lines
1.6 KiB
ReStructuredText
47 lines
1.6 KiB
ReStructuredText
===============
|
|
Getting Started
|
|
===============
|
|
|
|
The web3.js library is a collection of modules which contain specific functionality for the ethereum ecosystem.
|
|
|
|
- The ``web3-eth`` is for the ethereum blockchain and smart contracts
|
|
- The ``web3-shh`` is for the whisper protocol to communicate p2p and broadcast
|
|
- The ``web3-bzz`` is for the swarm protocol, the decentralized file storage
|
|
- The ``web3-personal`` is for ethereum account management
|
|
|
|
The following page will describe how to install and add web3.js to your project.
|
|
You can find some extra examples in the :ref:`API-reference <api-reference>` and the `examples here <https://github.com/ethereum/web3.js/tree/master/examples>`_.
|
|
|
|
Please also check out these `useful patterns <https://github.com/ethereum/wiki/wiki/Useful-Ðapp-Patterns>`_ for building Ðapp.
|
|
|
|
|
|
.. _adding-web3:
|
|
|
|
Adding web3.js
|
|
==============
|
|
|
|
.. index:: npm
|
|
.. index:: bower
|
|
.. index:: meteor
|
|
|
|
First you need to get web3.js into your project. This can be done using the following methods:
|
|
|
|
- npm: ``npm install web3``
|
|
- bower: ``bower install web3``
|
|
- meteor: ``meteor add ethereum:web3``
|
|
- pure js: link the ``dist/web3.min.js``
|
|
|
|
After that you need to create a web3 instance and set a provider.
|
|
If you are in a ethereum supported Browser like Mist or MetaMask check if the ``web3`` object is available:
|
|
|
|
.. code-block:: javascript
|
|
|
|
if (typeof web3 !== 'undefined') {
|
|
web3 = new Web3(web3.currentProvider);
|
|
} else {
|
|
// set the provider you want from Web3.providers
|
|
web3 = new Web3(new Web3.providers.HttpProvider("http://localhost:8545"));
|
|
}
|
|
|
|
Thats it! now you can use the ``web3`` object.
|