{"id":30754282,"url":"https://github.com/reddit/play","last_synced_at":"2025-09-04T09:09:08.941Z","repository":{"id":204767224,"uuid":"712566562","full_name":"reddit/play","owner":"reddit","description":"🛝 A little playground for building apps on Reddit.","archived":false,"fork":false,"pushed_at":"2025-03-21T13:33:26.000Z","size":1073,"stargazers_count":11,"open_issues_count":3,"forks_count":8,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-08-05T06:16:59.127Z","etag":null,"topics":["devvit","playground"],"latest_commit_sha":null,"homepage":"https://developers.reddit.com/play","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reddit.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-10-31T18:12:01.000Z","updated_at":"2025-06-18T02:10:34.000Z","dependencies_parsed_at":"2023-11-11T17:30:35.738Z","dependency_job_id":"f8bd35ed-e68c-4805-b9ed-5c9a79255330","html_url":"https://github.com/reddit/play","commit_stats":null,"previous_names":["reddit/play"],"tags_count":43,"template":false,"template_full_name":null,"purl":"pkg:github/reddit/play","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reddit%2Fplay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reddit%2Fplay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reddit%2Fplay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reddit%2Fplay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reddit","download_url":"https://codeload.github.com/reddit/play/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reddit%2Fplay/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273581245,"owners_count":25131393,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-04T02:00:08.968Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["devvit","playground"],"created_at":"2025-09-04T09:07:55.505Z","updated_at":"2025-09-04T09:09:08.926Z","avatar_url":"https://github.com/reddit.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ![:play](src/favicon/favicon48.png) :play\n\nA little playground for building apps on Reddit.\n\n## Installation\n\n```bash\nnpm install --save-prefix= @devvit/play\n```\n\nSee the [changelog](docs/changelog.md) for release notes.\n\n### Usage\n\nImport play in your JavaScript bundle to define the `play-pen` element:\n\n```ts\nimport '@devvit/play/pen'\n```\n\nAdd a pen to your HTML markup:\n\n```html\n\u003cplay-pen\u003e\n  \u003cscript type=\"application/devvit\"\u003e\n    import {Devvit} from '@devvit/public-api'\n\n    Devvit.addCustomPostType({\n      name: 'Say Hello',\n      render: () =\u003e \u003ctext\u003eHello!\u003c/text\u003e\n    })\n\n    export default Devvit\n  \u003c/script\u003e\n\u003c/play-pen\u003e\n```\n\n### Artifacts\n\nPublished releases include:\n\n- **play-.\\*.html**: portable playground (Firefox only since v0.0.32).\n- **play-pen.js**: `play-pen` element.\n- **play.js**: library utilities.\n\n## Development\n\n```bash\nnpm install\nnpm start\n```\n\nVisit **[http://localhost:1234](http://localhost:1234)** in your web browser.\nRun `npm test` to execute tests.\n\nSee [supplemental development notes](docs/development.md).\n\n### NPM scripts\n\n- `install`: install play dependencies.\n- `start`: run development server.\n- `test`: build play and execute all tests. Anything that can be validated\n  automatically before publishing runs through this command.\n- `run test:unit`: run the unit tests. Pass `--update` to update all test\n  snapshots.\n- `run test:ui`: run the user interface integration tests. Pass `--manual` to\n  inspect browser and / or a filename to filter.\n- `run format`: apply lint fixes automatically where available.\n- `run build`: compile source inputs to artifacts under `dist/`.\n\n💡 Add `--` to pass arguments to the script command. For example,\n`npm run test:unit -- --update` to update snapshots.\n\n### Project Structure\n\n- **docs**/: supplemental play documentation.\n- **src**/: source inputs.\n- **tools**/: development tools for building :play.\n\n### Contribution Guidelines and Design Principles\n\n- Make it fun. play must be fun to use and fun to develop. Speed and quality are\n  play's top two features.\n- Avoid dependencies. Dependencies are high-cost integrations. Simply don't add\n  them.\n- Avoid code. Lines of code are costly. We probably can't afford your code if\n  you write a lot of it.\n- Open-source for everyone. This repo was started with the intention to be\n  open-sourced as soon as possible.\n  - All dependencies must be available publicly. Avoid closed-source Reddit\n    dependencies.\n  - Avoid Reddit-specific branding.\n- Code should be written to be read. We value good context. This often means\n  including short inline or accompanying docs.\n- Keep the interface and outputs plain and simple. play is only a tool. The\n  user's focus is their work.\n- Every commit should be an overall improvement. If every commit is an\n  improvement, the code only gets better.\n- Smaller patches get better reviews.\n\n## [License (BSD-3-Clause)](license.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freddit%2Fplay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freddit%2Fplay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freddit%2Fplay/lists"}