Nimiq is the first Browser-based Blockchain.

1. Clone this repository git clone git@github.com:nimiq-network/core.git.
2. Run npm install or yarn
3. Run ./node_modules/.bin/gulp build
4. Open clients/browser/index.html in your browser to access the Browser Client.

Follow the Quickstart guide.

Open clients/browser/index.html in your browser.

To run a NodeJs Client you will need a publicly routable IP, Domain and SSL Certificate (get a free one at letsencrypt.org). Start the client by running clients/nodejs/index.js.

cd clients/nodejs/
node index.js --host <hostname> --port <port> --key <privkey> --cert <certificate>

Just include <script src="dist/nimiq.js"></script> in your project.

Visit the API Documentation.

Developers are free to choose between npm and yarn for managing the dependencies.

• NodeJs latest version (> 7.9.0)

• gulp: npm install gulp -g

• jasmine test framework: npm install jasmine -g

• Dependencies: npm install

• NodeJs dependencies:

   cd src/main/platform/nodejs/
   npm install
   cd clients/nodejs/
   npm install

• NodeJs latest version (> 7.9.0)

• Dependencies: yarn

• NodeJs dependencies:

   cd src/main/platform/nodejs/
   yarn
   cd clients/nodejs/
   yarn

If you decided on using yarn for managing the dependencies, you have to use node_modules/.bin/gulp instead of gulp and node_modules/.bin/jasmine instead of jasmine in the following.

• gulp test runs the testsuite in your browser.
• jasmine runs the testsuite in NodeJs.

gulp eslint runs the ESLint javascript linter.

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

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

This project is under the Apache License 2.0