https://github.com/getlark/previewuse
Automated preview environment generation
https://github.com/getlark/previewuse
Last synced: 11 days ago
JSON representation
Automated preview environment generation
- Host: GitHub
- URL: https://github.com/getlark/previewuse
- Owner: getlark
- Created: 2026-03-30T19:07:10.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-05-25T20:09:16.000Z (21 days ago)
- Last Synced: 2026-05-25T22:12:14.571Z (21 days ago)
- Language: Shell
- Size: 44.9 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# previewuse
Per-branch preview environments for any Docker Compose project.
On each feature branch, CI spins up (or reuses) an EC2 instance, points DNS at it, runs `docker compose up`, and comments the preview URLs on the PR. Caddy terminates TLS via Let's Encrypt. When the PR closes, the instance and DNS records are torn down.
## Quickstart
From the root of your repo:
```bash
curl -fsSL https://raw.githubusercontent.com/getlark/previewuse/main/install.sh | bash
```
This drops the scripts, compose file, example configs, and Claude Code skills into your repo.
Then point your coding agent at the two shipped skills, in order:
1. **`/configure-preview-deploy`** — fills in `preview.config.sh`, `Caddyfile`, `docker-compose.preview.yml`, and the CI workflow using signals from your repo.
2. **`/provision-preview-aws`** — creates the AWS resources (S3 bucket, EC2 key pair, security group, IAM roles, OIDC provider) and pushes CI secrets via `gh secret set`. Confirms each action before running it.
That's it — open a PR with the `deploy-preview` label and CI will post the preview URLs.
## License
MIT.