December 11, 2018

447 words 3 mins read



Official JavaScript implementation of the Nimiq protocol

repo name nimiq/core-js
repo link
language JavaScript
size (curr.) 13611 kB
stars (curr.) 935
created 2017-05-09
license Other

Nimiq Blockchain Build Status

Nimiq is a frictionless payment protocol for the web.



Check out our Testnet.


Prebuilt binary packages

For users looking to run a standalone Nimiq node (which is also capable of mining), see our Downloads page for installable Linux and Windows binary packages.

NPM Packages

For developers looking to include Nimiq support on their applications, there are two npm packages available:

  • @nimiq/core: Module for use in node.js applications.
  • @nimiq/core-web: Module for use in client-side (browser) applications (includes the same files that are available from our CDN).


  1. Install Node.js v8.10.0 or higher.
  2. On Ubuntu and Debian, install git and build-essential: sudo apt-get install -y git build-essential.
  3. Install yarn globally: sudo npm install -g yarn.
  4. Install gulp globally: yarn global add gulp.
  5. Clone this repository: git clone
  6. Build the project: cd core-js && yarn && yarn build.
  7. Open clients/browser/index.html in your browser.

Web Developers

Simple Web Application on top of Nimiq

A good way to get started is to have a look at the most simple web application on top of the Nimiq Blockchain.

Getting Started

Follow the Quickstart guide or make use of our CDN:

<script src=""></script>

Browser client

Open clients/browser/index.html in your browser or include <script src="dist/nimiq.js"></script> in your project.

Node.js client

To run a Node.js client you will need a publicly routable IP, Domain, and SSL Certificate (get a free certificate at Start the client by running clients/nodejs/nimiq with the respective configuration.

Test and Build

Run Testsuite

  • yarn test runs browser and Node.js tests.
  • yarn test-browser runs the testsuite in your browser only.
  • yarn test-node runs the testsuite in Node.js only.

Run ESLint

yarn lint runs the ESLint javascript linter.


Executing yarn build concatenates all sources into dist/{web,web-babel,web-crypto,node}.js


If you’d like to contribute to the development of Nimiq please follow our Code of Conduct and Contributing Guidelines.


This project is under the Apache License 2.0.

comments powered by Disqus