Quickstart

Here's the tl;dr for building on the Developer Platform. Apps are written in TypeScript. Before you get started, ensure that Node.js is installed. Additionally, you'll need to moderate ('everything' permissions) a test subreddit (less than 50 members).

Run the following commands to install the @devvit CLI, then create, upload, and preview your app:

npm

npm install -g devvit
devvit login
devvit new my-project
cd my-project
npm install
devvit upload
devvit playtest <your-subreddit>

Yarn

yarn global add devvit
devvit login
devvit new my-project
cd my-project
yarn
devvit upload
devvit playtest <your-subreddit>

pnpm

pnpm install -g devvit
devvit login
devvit new my-project
cd my-project
pnpm install
devvit upload
devvit playtest <your-subreddit>

Visit your subreddit and interact with your app. As you make and save code modifications, Playtest will automatically build and deploy the app to your subreddit. Simply refresh the page to view the latest changes.

While the playtest is active, you will be streaming logs from the app. This is useful for debugging and gaining insights into how your app is running.

To stop the playtest, press Ctrl + c.

Next steps

Now you know how to create and deploy apps! Next up, try the following:

• Check out the examples to see what others have created.
• Follow the Remind Me tutorial.