An experimental hello world template that explores a new way to build applications on Reddit's developer platform.
If you're looking for a more batteries included starter, please check out:
Make sure you have Node 22 downloaded on your machine before running!
- Create your project from the template
- Set up your new repo
- Clone the repo down to your computer
cd your-app-name
npm install
- Make a subreddit: Make a private subreddit on Reddit.com. This will be where you do your own development. Go to Reddit.com, scroll the left side bar down to communities, and click "Create a community."
- Update the name in package.json: Find the
dev:devvit
command and replaceYOUR_SUBREDDIT_NAME
with the subreddit name you just created. - Update json file: In
devvit.json
replaceYOUR_APP_NAME
with the name of your app. This will be shown to users that play your app. - Upload: Run
npm run deploy
and go through the prompts - Playtest: Run
npm run dev
to playtest your application in production by going to your subreddit. Use the subreddit menu action called "New Hello World Post" to create the post.
npm run dev
: Starts a development server where you can develop your application live on Reddit.npm run deploy
: Uploads a new version of your appnpm run type-check
: Type checks your app