@iota-pico/api-examples-browser

IOTA Pico Framework API Examples for Browser

Stats

StarsIssuesVersionUpdatedCreatedSize
@iota-pico/api-examples-browser
1.0.03 years ago4 years agoMinified + gzip package size for @iota-pico/api-examples-browser in KB

Readme

GitHub license Build Status

IOTA Pico Framework Examples for Browser in TypeScript

Example code for using IOTA Pico Framework with Browser written in TypeScript.

Installation

npm install @iota-pico/api-examples-browser

Running

You can run the examples by serving the web pages locally by running:

npm run serve

The will automatically start a web server and launch the index page containing links to all the examples.

Configuration

If you want to modify the node that is used to service the examples please modify the config file config/networkConfig.json.

To connect to a node use:

{
    "protocol": "https",
    "host": "nodes.thetangle.org",
    "port": 443
}

Library

The IOTA Pico Framework is a multi-layered set of object oriented JavaScript libraries for use with the IOTA tangle.

If you don't want to use the layered versions of the libraries consider using the ready bundled versions:

Each layer is fully abstracted allowing you to replace components with your own implementations very easily.

The layered libraries are written in TypeScript so are all strongly typed. The modules are generated as ES6 so you may need to transpile them when including them for use in older JavaScript eco-systems. The code will run without transpilation in all modern browsers and when used by NodeJs.

Contributing

Contributions are always welcome to the project. Feel free to raise issues, create pull requests or just make suggestions.

Authors

Come and find us on the IOTA Discord development channels

Donations

IOTA donations are always welcome :smile:

pico@tngl-me

License

This project is licensed under the MIT License - see the LICENSE file for details.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.