quickstart.mdx

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import BlocksMenu from './assets/blocks_post_menu.png'; import BlocksPost from './assets/blocks_post_example.png';

Quickstart

This guide will help you create your first Reddit Developer Platform app in minutes. For a more detailed walkthrough, see the building an app guide.

Prerequisites

Before you start, you'll need:

• Node.js (v22.2.0+)
• A test subreddit that you moderate (with less than 200 members)
  • After creating a test subreddit, visit your Safety Filters under mod tools (https://www.reddit.com/mod/[your_subreddit_name]/safety) and turn off the Reputation filter
• A code editor (we recommend VS Code)

Need help installing Node.js?

You'll need Node.js to work with TypeScript and Devvit. Here are two ways to install it:

Option 1: Using nvm (Recommended)

nvm lets you easily manage multiple Node.js versions.

For macOS/Linux:

# 1. Install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.6/install.sh | bash

# 2. Close and reopen terminal

# 3. Install Node.js
nvm install node

For Windows:

1. Install nvm-windows
2. Restart terminal
3. Run nvm install node

Option 2: Direct Installation

1. Download from Node.js website
2. Run the installer

:::caution Direct installation may cause permissions issues. We recommend using nvm instead. :::

Verify Installation

node --version
npm --version

Video tutorial

Watch this video and see how easy it is to create an app. The tutorial starts at 1:35.

<iframe width="xxx" height="xxx" src="https://www.youtube.com/embed/BHtTIInycgg" title="Getting started with Reddit's Developer Platform" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen ></iframe>

Step-by-step guide

Follow these steps to install Devvit and create your first app.

1. Install the Devvit CLI - Choose your preferred package manager:

```bash npm install -g devvit ``` ```bash yarn global add devvit ``` ```bash pnpm install -g devvit ```

2. Log in to Reddit

devvit login

3. Create a new project

devvit new --template blocks-post
cd my-project

:::tip Pro tip If you're already a savvy web developer, use --template web-view-post (instead of the blocks-post template in step 3) to use the webview component features. :::

4. Upload your app

devvit upload

5. Playtest your app

devvit playtest <my-subreddit>

:::tip Replace <my-subreddit> with your test subreddit name (e.g., devvit playtest r/MyTestSub). :::

Test your app

1. Visit your subreddit
2. In your menu actions, you should see a button that says "Add my post"
3. Refresh your subreddit page, and you should see a counter app
4. As you make code changes, playtest automatically rebuilds and deploys
5. Simply refresh the page to see your latest changes
6. View realtime logs while playtest is active
7. Press Ctrl + c to stop playtest

:::tip If you don't see your post, visit your Safety Filters under mod tools (https://www.reddit.com/mod/[your_subreddit_name]/safety), turn off the Reputation filter, and try again. :::

Choose your path

Here are the recommended next steps:

• Learn about building interacative posts
• Check out the showcase to see example apps
• Learn how to publish your app

:::note Reddit collects usage metrics when you use the Devvit CLI. See Reddit's Developer Terms and Privacy Policy. Opt out with devvit metrics off. :::