Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/partykit/remix-starter
🎈 PartyKit ⤫ Remix 💿
https://github.com/partykit/remix-starter
collaborative multiplayer partykit react real-time remix-stack serverless websockets yjs
Last synced: 3 days ago
JSON representation
🎈 PartyKit ⤫ Remix 💿
- Host: GitHub
- URL: https://github.com/partykit/remix-starter
- Owner: partykit
- License: mit
- Created: 2023-08-26T13:57:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-26T12:36:24.000Z (5 months ago)
- Last Synced: 2024-08-26T14:54:39.220Z (5 months ago)
- Topics: collaborative, multiplayer, partykit, react, real-time, remix-stack, serverless, websockets, yjs
- Language: TypeScript
- Homepage:
- Size: 189 KB
- Stars: 71
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Welcome to 🎈 PartyKit ⤫ Remix 💿!
This is a starter template for [Remix](https://remix.run) and [PartyKit](https://partykit.io). You can create a new project based on this template with the Remix CLI:
```sh
npx create-remix@latest --template partykit/remix-starter
```
- [Remix Docs](https://remix.run/docs)
- [PartyKit Docs](https://docs.partykit.io/)
_NB: This is a **beta** release, so expect some rough edges. Please file issues or feedback at https://github.com/partykit/remix-starter!_
## Development
You will be running two processes during development:
- The Remix development server
- The PartyKit server
Both are started with one command:
```sh
npm run dev
```
Open up [http://127.0.0.1:1999](http://127.0.0.1:1999) and you should be ready to go!
If you want to check the production build, you can stop the dev server and run following commands:
```sh
npm run build
npm start
```
Then refresh the same URL in your browser (no live reload for production builds).
## Deployment
```sh
npm run deploy
```
If you don't already have a PartyKit account, you'll be prompted to create one during the deploy process.
## Thanks
_(This starter based on the original template for [Cloudflare Workers](https://github.com/remix-run/remix/tree/main/templates/cloudflare-workers))_