Installation

Learn how to bootstrap a new custom application using the Sanity SDK.

The Sanity App Software Development Kit (App SDK) is distributed as two separate npm packages – the core TypeScript SDK, and a ready-to-go React implementation.

• @sanity/sdk
• @sanity/sdk-react

While the core SDK can be used on its own, its primary purpose is to enable the React SDK’s functionality, as well as to leave the door open for other framework-specific implementations in the future. For now, our React SDK is our primary focus, and it’s what we’ll be installing via the bootstrapping process described below.

• Some familiarity with JavaScript and/or TypeScript development
• A terminal
• Node.js v20

Use the sanity Command Line Interface (CLI) to initialize a new application. A new React app with all the necessary dependencies and boilerplate will be created.

npx sanity@latest init --template app-quickstart

Your app will be bootstrapped and preconfigured with your organization ID. If you have ever worked on a Sanity Studio project locally, this should feel familiar.

Before running your app locally, you’ll need to add a small bit of configuration, which we’ll walk through in the next article.

• Read the App SDK Quickstart Guide to get up and running quickly
• Read about the Sanity CLI