Welcome to the Nimiq Developer Center!

Dive into the Nimiq Ecosystem documentation with links to resources, tutorials, and assets.

Get Started

Build your own Nimiq-enabled app. Step by step with code snippets and a full running example at the end of each tutorial.

Tutorials

You can set up a Nimiq node within your browser that will connect to the Nimiq network and reach consensus using the Nimiq library at https://cdn.nimiq.com/nimiq.js in basically three lines:

window.onload = function(){
    Nimiq.init(async function() {

        // Configure for testing / otherwise main()
        Nimiq.GenesisConfig.test();

        // Getting a Nimiq Nano Client instance
        const consensus = await Nimiq.Consensus.nano();

        // Connecting to the network
        consensus.network.connect();
    }
}

But there is more! Learn in the tutorials below how to build a small webapp with JavaScript, HTML, and CSS that manages a wallet, send and receive transactions, and looks neat using Nimiq's look & feel.

More to come. Want to contribute? Please get in touch.

Run a node

The minimum example: On Linux and Mac, all you need is an IP and an open or forwarded port to run a full node.

git clone https://github.com/nimiq-network/core.git nimiq && cd nimiq
yarn && yarn build
clients/nodejs/nimiq --host=IP --port=PORT --protocol=ws 

Note: For further details and instructions for Windows users, refer to the Nimiq Core Documentation.

Run a miner: just add configuration for threads and address

--miner=auto --wallet-address=ADDRESS 

For more details, see:

Integrate checkout

Coming soon. Team Nimiq is preparing to release a plugin to integrate Nimiq with WooCommerce in Q1 2019. Together with this we plan to publish detailed instructions on how to use it here.

API Documentation

Nuts and bolts of Nimiq. Detailed documentation of front-end, core and community-provided APIs and frameworks.

Assets

Bits and bytes. Browse through Nimiq's source code. New to Nimiq's look & feel? Checkout Nimiq's Style Guide and download brand assets such as logos and signets.

Nimiq Style

The Nimiq CSS framework to give your webapp or website the Nimiq look & feel.

Source Code

The Nimiq Source Code is hosted on GitHub in two separate projects.