turborepo-remote-cache-cloudflare - GitLite

KO | EN

gitlite — search

#python #react #android #machine-learning #deep-learning #docker #nodejs #awesome #kubernetes #vue #awesome-list #security #ios #open-source

turborepo-remote-cache-cloudflare

(★ 238)

An implementation of the turborepo-remote-cache server custom made for Cloudflare Workers

파일 탐색기

최종 버전 다운로드 (.zip)

- config.json
- README.md
- - bug_report.md
  - feature_request.md
- - ci.yml
  - dependency-review.yml
  - deploy-docs.yml
  - deploy.yml
  - docs-pr-preview.yml
  - release.yml
- CODE_OF_CONDUCT.md
- CODEOWNERS
- CONTRIBUTING.md
- pull_request_template.md
- renovate.json
- SECURITY.md
- settings.json
- - config.ts
- - kv-storage.md
  - project-configuration.md
  - r2-storage.md
- - getting-started.md
  - setup-turborepo.md
- - _headers
  - favicon.ico
- index.md
- - deleteOldCache.ts
- - auth.ts
  - index.ts
  - internal.ts
- - index.ts
  - interface.d.ts
  - kv-storage.ts
  - r2-storage.ts
  - storage-manager.ts
- - date.ts
- index.ts
- - deleteOldCache.test.ts
- - index.test.ts
  - internal.test.ts
- - kv-storage.test.ts
  - r2-storage.test.ts
  - storage-manager.test.ts
- - date.test.ts
- index.test.ts
.dev.vars
.editorconfig
.gitignore
.ncurc.json
.node-version
.nvmrc
.oxfmtrc.json
.oxlintrc.json
AGENTS.md
CHANGELOG.md
CLAUDE.md
LICENSE
package.json
pnpm-lock.yaml
pnpm-workspace.yaml
README.md
tsconfig.json
turbo.json
vite.config.ts
vitest-env.d.ts
vitest.config.ts
worker-configuration.d.ts
wrangler.jsonc

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/AdiRishi/turborepo-remote-cache-cloudflare

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd turborepo-remote-cache-cloudflare

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

pnpm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

pnpm wrangler r2 bucket create turborepo-cache

이 명령어를 터미널에 그대로 입력해 실행하세요.

pnpm run deploy

이 명령어를 터미널에 그대로 입력해 실행하세요.

echo "SECRET" | pnpm wrangler secret put TURBO_TOKEN

이 명령어를 터미널에 그대로 입력해 실행하세요.

pnpm add -D dotenv-cli

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">

# Turborepo Remote Cache (For Cloudflare Workers!)

</div>

<div align="center">

[![CI](https://github.com/AdiRishi/turborepo-remote-cache-cloudflare/actions/workflows/ci.yml/badge.svg)](https://github.com/AdiRishi/turborepo-remote-cache-cloudflare/actions/workflows/ci.yml) [![Coverage Status](https://coveralls.io/repos/github/AdiRishi/turborepo-remote-cache-cloudflare/badge.svg)](https://coveralls.io/github/AdiRishi/turborepo-remote-cache-cloudflare) ![GitHub License](https://img.shields.io/github/license/AdiRishi/turborepo-remote-cache-cloudflare) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://raw.githubusercontent.com/AdiRishi/turborepo-remote-cache-cloudflare/master/.github/CONTRIBUTING.md)

<a href="https://adirishi.github.io/turborepo-remote-cache-cloudflare" target="_blank">
  <img src="https://img.shields.io/badge/Visit-Developer%20Docs-%230572BE?style=for-the-badge&logo=readthedocs&logoColor=white" alt="Visit Developer Docs">
</a>

</div>

## 🚀 Introduction

This project offers an open source implementation of the [Turborepo custom remote cache server](https://turbo.build/repo/docs/core-concepts/remote-caching) **purpose-built from the ground up for [Cloudflare Workers](https://developers.cloudflare.com/workers/)**

📚 For detailed documentation, please refer to our [official website](https://adirishi.github.io/turborepo-remote-cache-cloudflare)

> [!IMPORTANT]
> You can now store your build artifacts in either Cloudflare 🪣 R2 or 🔑 KV storage. Find out how in our [official documentation](https://adirishi.github.io/turborepo-remote-cache-cloudflare/configuration/kv-storage)

## 🤔 Why should I use this?

If you're a Turborepo user, this project offers compelling advantages:

- 💿 **Storage Options**: Choose between 🪣 [R2](https://adirishi.github.io/turborepo-remote-cache-cloudflare/configuration/r2-storage) or 🔑 [KV](https://adirishi.github.io/turborepo-remote-cache-cloudflare/configuration/kv-storage) storage for your build artifacts. This gives you the flexibility to choose the storage option that best fits your needs.
- 🚀 **Faster Builds**: Harness the power of remote caching to significantly speed up your builds
- 🌐 **Independence from Vercel**: Use Turborepo without tying your project to Vercel. This gives you flexibility in hosting decisions.
- 🌍 **Global Deployment**: Code deploys instantly across the globe in over 300 countries, ensuring unmatched performance and reliability.
- 💰 **Affordable Start**: With Cloudflare Workers' [generous free tier](https://developers.cloudflare.com/workers/platform/pricing), you can make up to 100,000 requests every day at no cost. Even better Cloudflare has [zero egress fees](https://www.cloudflare.com/en-au/learning/cloud/what-are-data-egress-fees/) on it's platform, meaning you only pay for what you use.

## ⚡️ Quick start

[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/AdiRishi/turborepo-remote-cache-cloudflare)

### Deploy Using the CLI

This project already comes with [wrangler](https://developers.cloudflare.com/workers/wrangler/) (cloudflare's CLI tool for managing works) installed and configured, so all you need to do is clone this repository and run `pnpm run deploy`.

```sh
# 1. Clone the repository
git clone https://github.com/AdiRishi/turborepo-remote-cache-cloudflare.git

# 2. Install packages
pnpm install

# 3. Create the R2 bucket for storage
pnpm wrangler r2 bucket create turborepo-cache

# 4. Publish the project
pnpm run deploy

# 5. Set a Bearer auth token
echo "SECRET" | pnpm wrangler secret put TURBO_TOKEN
```

## ⚙️ Configuration

### Github actions requirements

In order to successfully run the [deploy](.github/workflows//deploy.yml) Github action you will need the following secrets

- `CLOUDFLARE_API_TOKEN`
- `CLOUDFLARE_ACCOUNT_ID`
- `TURBO_TOKEN`

For those who have forked this repository, feel free to delete the [release.yml](https://github.com/AdiRishi/turborepo-remote-cache-cloudflare/blob/master/.github/workflows/release.yml) workflow file. This is only used to automatically publish new releases of this repository to GitHub releases.

### Automatic deletion of old cache files

This project sets up a [cron trigger](https://developers.cloudflare.com/workers/platform/triggers/cron-triggers/) for Cloudflare workers, which automatically deletes old cache files within the bound R2 bucket. This behavior can be customized:

- To disable the automatic deletion, remove the [triggers] configuration in [wrangler.jsonc](./wrangler.jsonc)
- To change the retention period for objects, adjust the `BUCKET_OBJECT_EXPIRATION_HOURS` option in [wrangler.jsonc](./wrangler.jsonc) or set it via [workers environment variables](https://developers.cloudflare.com/workers/platform/environment-variables/)

## ▲ Setting up remote caching in your Turborepo project

Here's my recommended approach for setting up remote caching in your Turborepo project. You can read more about this topic in the [official Turborepo documentation](https://turbo.build/repo/docs/core-concepts/remote-caching).

### Step 1: Update `turbo.json`

Modify the `turbo.json` file at your project root to include [signature validation](https://turbo.build/repo/docs/core-concepts/remote-caching#artifact-integrity-and-authenticity-verification)

```json
{
    "remoteCache": { "signature": true }
}
```

### Step 2: Install `dotenv-cli`

Install the `dotenv-cli` npm package:

```sh
# You may have to add -W if you are installing this on your workspace root
pnpm add -D dotenv-cli
```

### Step 3: Create a `.env` File

Create a `.env` file at your project root with the following content:

```dotenv
TURBO_API=YOUR_API_URL # Remember to remove the trailing slash
TURBO_TEAM=team_my_team_name
TURBO_TOKEN=SECRET # The turbo token must be a valid Bearer auth token
TURBO_REMOTE_CACHE_SIGNATURE_KEY=SECRET
```

Keep the following in mind

- Replace `SECRET` and `YOUR_API_URL` with your chosen values.
- Turborepo requires that the `TURBO_API` value must not end with a trailing slash
- The `TURBO_TEAM` value must begin with `team_`
- Remember to add the `.env` file to `.gitignore`
- If you are building your project in some remote CI tool (like Github Actions) you need to make these environment variables available to your build script

### Step 4: Modify Turbo Commands

Load the `.env` file prior to execution. Instead of running a command like `turbo run build` directly, use `dotenv -- turbo run build`. This loads everything in our `.env` file into the process's environment variables.

Here's how to modify your scripts in `package.json` to use dotenv-cli:

```json
{
    "scripts": {
        "build": "dotenv -- turbo run build",
        "dev": "dotenv -- turbo run dev",
        "lint": "dotenv -- turbo run lint",
        "test": "dotenv -- turbo run test"
    }
}
```

And that's it 🎉🎉

Whenever you run a turbo command you will see `Remote cache enabled` in it's log output

```
pnpm lint

$ dotenv -- turbo run lint
• Packages in scope: turborepo-project, webapp, docs
• Running lint in 3 packages
• Remote caching enabled

...output

Tasks:    3 successful, 3 total
Cached:    3 cached, 3 total
  Time:    1.174s >>> FULL TURBO

✨  Done in 3.54s.
```

---

<div align="center">

Made with ❤️

</div>