{"id":17788265,"url":"https://github.com/nickytonline/astro-partykit-starter","last_synced_at":"2025-10-04T00:14:05.978Z","repository":{"id":213881325,"uuid":"735162507","full_name":"nickytonline/astro-partykit-starter","owner":"nickytonline","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-02T00:34:16.000Z","size":1954,"stargazers_count":11,"open_issues_count":12,"forks_count":9,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-08T14:42:44.036Z","etag":null,"topics":["astro","partykit","react"],"latest_commit_sha":null,"homepage":"https://astro-partykit-react-starter.netlify.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nickytonline.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":null,"code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"nickytonline","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-12-23T22:16:24.000Z","updated_at":"2025-05-05T01:48:37.000Z","dependencies_parsed_at":"2024-01-12T18:20:21.568Z","dependency_job_id":"c7d18d0e-3a38-4573-83c7-e0dfa55ef0e3","html_url":"https://github.com/nickytonline/astro-partykit-starter","commit_stats":null,"previous_names":["nickytonline/multicam","nickytonline/astro-partykit-starter"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/nickytonline/astro-partykit-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickytonline%2Fastro-partykit-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickytonline%2Fastro-partykit-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickytonline%2Fastro-partykit-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickytonline%2Fastro-partykit-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nickytonline","download_url":"https://codeload.github.com/nickytonline/astro-partykit-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickytonline%2Fastro-partykit-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278245587,"owners_count":25955055,"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-10-03T02:00:06.070Z","response_time":53,"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":["astro","partykit","react"],"created_at":"2024-10-27T10:18:13.885Z","updated_at":"2025-10-04T00:14:05.952Z","avatar_url":"https://github.com/nickytonline.png","language":"TypeScript","funding_links":["https://github.com/sponsors/nickytonline"],"categories":[],"sub_categories":[],"readme":"# Astro Partykit Minimal Starter Kit\n\nThis is a minimal starter kit for [Astro](https://astro.build) and [Partykit](https://partykit.io) using [React](https://reactjs.org/).\n\n## 🧞 Commands\n\nAll commands are run from the root of the project, from a terminal:\n\n| Command                   | Action                                                                                                             |\n| :------------------------ | :----------------------------------------------------------------------------------------------------------------- |\n| `npm install`             | Installs dependencies                                                                                              |\n| `npm run dev`             | Starts local dev server at `localhost:4321` as well as partykit on `localhost:1999`                                |\n| `ntl dev`                 | Starts Netlify integration along with local dev server at `localhost:8888` as well as partykit on `localhost:1999` |\n| `npm run build`           | Build your production site to `./dist/`                                                                            |\n| `npm run preview`         | Preview your build locally, before deploying                                                                       |\n| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check`                                                                   |\n| `npm run astro -- --help` | Get help using the Astro CLI                                                                                       |\n| `npm run test`            | Run tests with Vitest                                                                                              |\n\nIf you plan to use Netlify, you need to install the [Netlify CLI](https://docs.netlify.com/cli/get-started/) to run `ntl dev`.\n\n## 👀 Want to learn more about Astro?\n\nFeel free to check [their documentation](https://docs.astro.build) or jump into their [Discord server](https://astro.build/chat).\n\n## 👀 Want to learn more about Partykit?\n\nFeel free to check [their documentation](https://docs.partykit.io/) or jump into their [Discord server](https://discord.gg/KDZb7J4uxJ).\n\n## 🚀 Project Structure\n\nInside of your Astro project, you'll see the following folders and files:\n\n```text\n/\n├── public/\n├── party/\n│   └── index.ts\n├── src/\n│   └── components/\n│       └── Party.tsx\n│   └── pages/\n│       └── index.astro\n│       └── chat/\n│           └── index.astro\n|   └── tests/\n│           └── basic.test.ts\n└── package.json\n```\n\nAstro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.\n\n`src/components/` is where components go, Astro/React/Vue/Svelte/Preact components. For this starter project, we're using React, but feel free to switch to your favorite framework.\n\nAny static assets, like images, can be placed in the `public/` directory.\n\n## Deployment\n\n### Setting up Environment Variables\n\n1. Run `npx partykit@latest token generate` to generate a token.\n2. Run `ntl env:set PARTYKIT_LOGIN your-username` to add it to the environment variables for Netlify deploys.\n3. Run `ntl env:set PARTYKIT_TOKEN THE_GENERATED_SUPER_SECRET_TOKEN` to add it to the environment variables for Netlify deploys.\n4. Run `ntl env:set PUBLIC_PARTYKIT_HOST set-your-url-here` so that the production URL for Partykit is available for the deployment.\n\n_Note_: The `ntl env:set` command is for Netlify deployments only. If you choose to deploy elsewhere, please refer to those particular docs on setting environment variables for your application.\n\n### Deploy to Netlify\n\nThe project is configured to deploy to Netlify. For more information on deploying to Netlify, see [A Step-by-Step Guide: Deploying on Netlify](https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/).\n\nIf you'd like to deploy via the Netlify CLI, you can run the following commands:\n\n```bash\nnpm install netlify-cli -g # Install the Netlify CLI\nnetlify init # Connect your project to Netlify\nnetlify deploy --build # Deploy your site add --prod for production\n```\n\n### Deploy to Partykit\n\nFor the Partykit side of things, you can use the [Partykit CLI](https://docs.partykit.io/reference/partykit-cli/).\n\n```bash\nnpx partykit deploy\n```\n\nFor more information see their [documentation](https://docs.partykit.io/guides/deploying-your-partykit-server).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickytonline%2Fastro-partykit-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnickytonline%2Fastro-partykit-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickytonline%2Fastro-partykit-starter/lists"}