{"id":18437853,"url":"https://github.com/zilliqa/zilliqa-javascript-library-examples","last_synced_at":"2025-10-10T21:41:22.950Z","repository":{"id":47375853,"uuid":"395628043","full_name":"Zilliqa/Zilliqa-JavaScript-Library-Examples","owner":"Zilliqa","description":null,"archived":false,"fork":false,"pushed_at":"2021-09-02T02:49:53.000Z","size":8130,"stargazers_count":2,"open_issues_count":0,"forks_count":8,"subscribers_count":16,"default_branch":"master","last_synced_at":"2023-03-29T03:47:08.982Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zilliqa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-13T11:24:48.000Z","updated_at":"2022-04-27T22:05:10.000Z","dependencies_parsed_at":"2022-08-22T08:20:55.576Z","dependency_job_id":null,"html_url":"https://github.com/Zilliqa/Zilliqa-JavaScript-Library-Examples","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2FZilliqa-JavaScript-Library-Examples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2FZilliqa-JavaScript-Library-Examples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2FZilliqa-JavaScript-Library-Examples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2FZilliqa-JavaScript-Library-Examples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zilliqa","download_url":"https://codeload.github.com/Zilliqa/Zilliqa-JavaScript-Library-Examples/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223291499,"owners_count":17120965,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T06:16:26.330Z","updated_at":"2025-10-10T21:41:17.920Z","avatar_url":"https://github.com/Zilliqa.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zilliqa-JavaScript-Library-Examples\n\nThis repository contains some examples on how to use [Zilliqa Javascript SDK](https://github.com/Zilliqa/Zilliqa-JavaScript-Library). Zilliqa Javascript can be used in two approaches; the common NodeJS approach and a traditional HTML Javascript approach. \n\n\n## NodeJS (Recommended)\nThe NodeJS approach is to add `@zilliqa-js/zilliqa` module from https://www.npmjs.com/package/@zilliqa-js/zilliqa. To use Zilliqa SDK in the project, users must `require` it in their frontend frameworks.\n```\nyarn add `@zilliqa-js/zilliqa`\n\n// index.js\nconst { Zilliqa } = require('@zilliqa-js/zilliqa');\nconst zilliqa = new Zilliqa('https://dev-api.zilliqa.com');\n```\n\nSee `node` for detailed examples.\n\n**This is the recommended way for frontend JS frameworks such as React, Angular, VueJS, etc.**\n\n\n## HTML script (Alternative)\nZilliqa Javascript can also be build to a `zilliqa.min.js` which allows users to import them into a HTML with the `\u003cscript\u003e` tag. One caveat is that users would need to build the minified JS file from the main project themselves.\n\n```\ngit clone https://github.com/Zilliqa/Zilliqa-JavaScript-Library\ncd Zilliqa-JavaScript-Library\nyarn install\nyarn build:web\n\n// zilliqa.min.js is generated under Zilliqa-JavaScript-Library/dist\ncp Zilliqa-JavaScript-Library/dist/zilliqa.min.js /webpack/react/public\n\ncd webpack/react\nyarn install\nyarn build:web\n```\n\nSee `webpack/html` and `webpack/react` for detailed examples.\n\n**Frontend developers should generally use the NodeJS approach to use Zilliqa SDK unless there are some constraints.**","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzilliqa%2Fzilliqa-javascript-library-examples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzilliqa%2Fzilliqa-javascript-library-examples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzilliqa%2Fzilliqa-javascript-library-examples/lists"}