https://github.com/moltar/cdk-turborepo-remote-caching
CDK Construct for Turborepo remote cache server.
https://github.com/moltar/cdk-turborepo-remote-caching
aws aws-cdk cache turbo turborepo
Last synced: 2 months ago
JSON representation
CDK Construct for Turborepo remote cache server.
- Host: GitHub
- URL: https://github.com/moltar/cdk-turborepo-remote-caching
- Owner: moltar
- License: apache-2.0
- Created: 2022-02-23T09:44:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-25T19:19:45.000Z (almost 4 years ago)
- Last Synced: 2025-06-22T22:34:43.827Z (about 1 year ago)
- Topics: aws, aws-cdk, cache, turbo, turborepo
- Language: TypeScript
- Homepage:
- Size: 389 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📦 `cdk-turborepo-remote-caching`
> CDK Construct for Turborepo remote cache server.
⚠️ **There is no authentication (yet) and the API endpoints are open to public (`--token` value is ignored).** ⚠️
This solution provides API Gateway (v1) that implements the Turborepo remote caching API interface
and S3 bucket for storing the cache artifacts.
## Usage
```ts
import { TurborepoRemoteCaching } from 'cdk-turborepo-remote-caching'
new TurborepoRemoteCaching(stack, 'TRC')
```
Get the API endpoint from the output:
```plain
https://abcdefg.execute-api.region-1.amazonaws.com/cache
```
Use it with `turbo run`:
Value for `--token` can be anything since there is no auth.
Team must be specified, and can be anything that begins with `team_`. This will namespace the cache
in the S3 bucket.
```sh
turbo run build --api="https://abcdefg.execute-api.region-1.amazonaws.com/cache" --token=x --team=team_whatever
```