Nebulas JavaScript API

This readme will get you started with using the neb.js file. This file can be found in go-nebulas/cmd/console/neb.js/dist/neb.js

This is the Nebulas compatible JavaScript API. Users can use it in brower and node.js.This javascript library also support API for our Repl console.

Step 1: We need to use NPM to install the dependencies before using neb.js:

Download Node.js:

Note: npm is a Node.js package manager. So this means you need to install Node.js in order to use npm install Node.js

Once you have Node.js installed we can go to the neb.js folder.

Example 1: in the terminal

cd go-nebulas/cmd/console/neb.js
npm install

Step 2: We need to use the `gulp` command

Download Gulp:

Note: In order to use the gulp command we need to install gulp:

Example 2 in the terminal:

cd go-nebulas/cmd/console/neb.js
gulp

Now we can check the newly created files in go-nebulas/cmd/console/neb.js/dist

cd go-nebulas/cmd/console/neb.js/dist

Here you should see a bunch of js files.

In the next tutorial I will show how to use neb.js file and make a make a program to interact with your local Nebulas installation.

Extra

Rollup is a module bundler for JavaScript which compiles small pieces of code into something larger and more complex, such as a library or application.

Build neb-node.js by rollup:

rollup -c

Library

neb.js:Used in brower side. Including outside dependency.
neb-light.js: Used in brower side and Repl console. Ignore outside dependency.
neb-node.js: Used in node.js. Including outside dependency.

Contribution

We are very glad that you are considering to help Nebulas Team, including but not limited to source code, documents or others.

If you'd like to contribute, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on our slack channel to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

Please refer to our contribution guideline for more information.

Thanks.

License

The go-nebulas project is licensed under the GNU Lesser General Public License Version 3.0 (“LGPL v3”).

For the more information about licensing, please refer to Licensing page.

jeffshek/neb.js