voluntas / remix-worker-template

📜 All-in-one remix starter template for Cloudflare Workers

remix-worker-template

The current starter template is based on Remix 1.1.3

• Repository
• Remix Docs

Differences with the Official CF Workers template

While the official template provides the bare minimums for you to kickstart a Remix app running on Cloudflare Workers, this starter template adds a few extra tools that are common for development and let you be productive right away. These tools include:

• Tailwind
• Playwright
• ESLint
• Prettier

In addition, it is now setup using a custom adapter based on the official Cloudflare Pages adapter. This allows us running a module worker with supports of Durable Objects. This is a temporay workaround until an official update is landed on the CF Worker adapter.

Node Version

Please make sure the node version is >= 16.7. If you are using nvm, just run:

nvm use

This allows miniflare to serve a development environment as close to the actual worker runtime as possibile.

Development

To starts your app in development mode, rebuilding assets on file changes, the recommended approach is:

npm run dev

This will run your remix app in dev mode using miniflare.

Testing

Before running the tests, please ensure the worker is built:

npm run build && npm run test

Deployment

To deploy your Remix app, simply do it with Wrangler using:

npx wrangler publish

CI/CD

The template ships a development workflow which is triggered whenever new changes are pushed.

To allow GitHub deploying the worker for you, following variables are required:

• CF_API_TOKEN
• CF_ACCOUNT_ID

These values could be found / created on your Cloudflare Dashboard. If your project is bootstrapped with the deploy button above, both should be already set in the repository.

Alternatively, CF_ACCOUNT_ID can be set as account_id on the wrangler.toml.