Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas Device SDKs
/

Build for IoT

On this page

  • Install the SDK for IoT
  • JavaScript Library

Placeholder page for information about building for IoT.

Include info about which frameworks we support building for IoT, plus any specific version or compatibility info worth calling out?

Install the SDK for IoT

JavaScript Library

To create a Node.js project and add the Node.js SDK on an Internet of Things (IoT) platform such as the Raspberry Pi 2, 3, or 4 running Raspberry Pi OS (formerly Raspbian), follow the steps below:

1

Install a C++ Compiler

The Node.js SDK's IoT library is not distributed as a binary, so you must build it from source. To do this, you'll need a working C++ compiler. To install such a compiler on your IoT device, run the following command:

sudo apt install build-essential g++ libssl-dev
2

Create a Node.js Project

Create your Node.js project by creating a new directory for your project and running npm init in that directory. In the example below, replace MyApp with your desired project name. Answer all of the prompts to fill out the details of your project.

mkdir MyApp && cd MyApp && npm init
3

Install the SDK with NPM

In your Node.js project directory, use the following command to add the SDK to your project:

npm install realm
4

Enable TypeScript (optional)

TypeScript is a superset of JavaScript that adds static type checking and other features intended to make application-scale development more robust. If you'd like to use TypeScript, follow the TypeScript team's official Node Starter guide. The SDK supports TypeScript natively and integrates easily into a TypeScript project.

← 
 →

On this page