Devvit Phaser Starter Experimental

An experimental starter that explores a new way to build applications on Reddit's developer platform.

• Devvit: A way to build and deploy immersive games on Reddit
• Vite: For compiling the webView
• Phaser: 2D game engine
• Express: For backend logic
• Typescript: For type safety

Getting Started

Prerequisites

Make sure you have Node 22 downloaded on your machine before running!

1. Create your project from the template
   
2. Set up your new repo
   
3. Clone the repo down to your computer
   
4. cd your-app-name
5. npm install
6. 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."
7. Update the name in package.json: Find the dev:devvit command and replace YOUR_SUBREDDIT_NAME with the subreddit name you just created.
8. Upload: Run npm run deploy and go through the prompts
9. Playtest: Run npm run dev to playtest your application in production by going to your subreddit.
10. Create Post: You you should see a subreddit menu action called "New Phaser Starter Post" to create your post.

Commands

• 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 app
• npm run check: Type checks, lints, and prettifies your app

Cursor Integration

This template comes with a pre-configured cursor environment. To get started, download cursor and enable the devvit-mcp when prompted.

Credits

Thanks to the Phaser team for providing a great template!