Nimiq Blockchain

Nimiq is a frictionless payment protocol for the web.

For a high-level introduction checkout the Nimiq White Paper.

Library Demo

Check out our betanet Browser Miner

Quickstart

Clone this repository git clone https://github.com/nimiq-network/core.
Run npm install or yarn
Run npm run build or yarn build
Open clients/browser/index.html in your browser to access the Browser Client.

Web Developers

Most simple Web Application on top of the Nimiq Blockchain

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

Installation for Web Developers

Follow the Quickstart guide or use our CDN:

<script src="https://cdn.nimiq.com/core/nimiq.js"></script>

Run Client

Run Browser Client

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

Run NodeJs client

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>

Argument	Description
*host*	Hostname of the NodeJs client.
*port*	Port used to communicate with the peers.
*key*	Private key for the client
*cert*	SSL certificate of your Domain.

Build your own Browser client

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

API

Visit the API Documentation.

Core Developers

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

Installation for Core Developers (using npm)

NodeJs latest version (> 7.9.0)
Dependencies: npm install

NodeJs dependencies:

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

Installation for Core Developers (using yarn)

NodeJs latest version (> 7.9.0)
Dependencies: yarn

NodeJs dependencies:

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

Test and Build

Run Testsuite

npm test or yarn test runs browser and NodeJS tests.
npm run test-browser or yarn test-browser runs the testsuite in your browser only.
npm run test-node or yarn test-node runs the testsuite in NodeJS only.

Run ESLint

npm run lint or yarn lint runs the ESLint javascript linter.

Build

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

Contribute

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

License

This project is under the Apache License 2.0

reperis / core