https://github.com/jacob-ebey/remix-cloudflare-worker-template
Remix + Cloudflare Workers + DO + Turborepo
https://github.com/jacob-ebey/remix-cloudflare-worker-template
Last synced: 12 months ago
JSON representation
Remix + Cloudflare Workers + DO + Turborepo
- Host: GitHub
- URL: https://github.com/jacob-ebey/remix-cloudflare-worker-template
- Owner: jacob-ebey
- Created: 2022-05-14T09:59:48.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-16T04:47:29.000Z (about 4 years ago)
- Last Synced: 2025-04-22T06:19:01.466Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://remix-cloudflare-worker-template.jacob-ebey.workers.dev
- Size: 410 KB
- Stars: 55
- Watchers: 3
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Remix + Cloudflare Workers + DO + Turborepo
A starter to get you up and going with Remix on Cloudflare with all the latest and greatest.
## What's inside?
This repo uses [npm](https://www.npmjs.com/) as a package manager. It includes the following packages/apps:
### Packages
- `packages/chat-room-do`: a Durable Object for chat rooms
- `packages/counter-do`: a Durable Object for counting things
- `packages/rate-limiter-do`: a Durable Object for limiting clients
- `packages/remix-app`: a [Remix](https://remix.run/) application that makes up the public facing UX
- `packages/worker`: a Cloudflare Worker that brings everything together for deployment
- `config/cloudflare-env`: type definitions for bindings shared across the packages
- `config/eslint-config-custom`: shared eslint config that includes `@remix-run/eslint-config` and `prettier`
- `config/tsconfig`: base tsconfig that other packages inherit from
Each `package/*` is 100% [TypeScript](https://www.typescriptlang.org/).
### Utilities
This turborepo has some additional tools already setup for you:
- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting
- [Github Actions](https://github.com/features/actions)
## Setup
Clone and install dependencies:
```
npm i
```
### Build
To build all apps and packages, run the following command:
```
npm run build
```
### Develop
To develop all apps and packages, run the following command:
```
npm run dev
```
### Remote Caching
Turborepo can use a technique known as [Remote Caching (Beta)](https://turborepo.org/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
By default, Turborepo will cache locally. To enable Remote Caching (Beta) you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:
```
npx turbo login
```
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:
```
npx turbo link
```
## Useful Links
Learn more about the power of Turborepo:
- [Pipelines](https://turborepo.org/docs/core-concepts/pipelines)
- [Caching](https://turborepo.org/docs/core-concepts/caching)
- [Remote Caching (Beta)](https://turborepo.org/docs/core-concepts/remote-caching)
- [Scoped Tasks](https://turborepo.org/docs/core-concepts/scopes)
- [Configuration Options](https://turborepo.org/docs/reference/configuration)
- [CLI Usage](https://turborepo.org/docs/reference/command-line-reference)