Getting started

Getting started with Nucleus is very easy.

By following this short guide you will have the basic functionalities (analytics and bug reports) working in 5 minutes.

Sign up and create an app

Start by signing up on the Nucleus platform.

Now, create your first app. You can name it as you want (you can change it later).

If you already have a version or an icon, you can now edit the app to set those elements.


In your app directory, run the following command to add the Nucleus module:

npm install electron-nucleus --save

Finally, enter the following piece of code in both your app's renderer and main process.

const Nucleus = require("electron-nucleus")("<Your App Id>")

And replace <Your App Id> by the id of the app you previously created.

That's it!

Now, as soon as some data is recorded, you will be able to see it in your Nucleus dashboard.