aduwoayooluwa / astro-partykit-starter

Astro Partykit Minimal Starter Kit

This is a minimal starter kit for Astro and Partykit using React.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
npm install	Installs dependencies
npm run dev	Starts local dev server at localhost:4321 as well as partykit on localhost:1999
ntl dev	Starts Netlify integration along with local dev server at localhost:8888 as well as partykit on localhost:1999
npm run build	Build your production site to ./dist/
npm run preview	Preview your build locally, before deploying
npm run astro ...	Run CLI commands like astro add, astro check
npm run astro -- --help	Get help using the Astro CLI

If you plan to use Netlify, you need to install the Netlify CLI to run ntl dev.

👀 Want to learn more about Astro?

Feel free to check their documentation or jump into their Discord server.

👀 Want to learn more about Partykit?

Feel free to check their documentation or jump into their Discord server.

🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
├── public/
├── party/
│   └── index.ts
├── src/
│   └── components/
│       └── Party.tsx
│   └── pages/
│       └── index.astro
│       └── chat/
│           └── index.astro
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

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.

Any static assets, like images, can be placed in the public/ directory.

Deployment

Deploy to Netlify

The project is configured to deploy to Netlify. For more information on deploying to Netlify, see A Step-by-Step Guide: Deploying on Netlify.

If you'd like to deploy via the Netlify CLI, you can run the following commands:

npm install netlify-cli -g # Install the Netlify CLI
netlify init # Connect your project to Netlify
netlify deploy --build # Deploy your site add --prod for production

Deploy to Partykit

For the Partykit side of things you can use the Partykit CLI.

npx partykit deploy

For more information see their documentation.