https://github.com/adriankeenan/cloud-url
A CDK-managed URL-shortener implemented in a CloudFront viewer function
https://github.com/adriankeenan/cloud-url
Last synced: 4 months ago
JSON representation
A CDK-managed URL-shortener implemented in a CloudFront viewer function
- Host: GitHub
- URL: https://github.com/adriankeenan/cloud-url
- Owner: adriankeenan
- License: unlicense
- Created: 2024-09-05T22:54:21.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-08T21:23:13.000Z (9 months ago)
- Last Synced: 2025-01-05T01:26:24.604Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 44.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cloud-url
A CDK-managed URL-shortener implemented in a CloudFront viewer function
Features:
- 1-click deploy via AWS CDK
- ~100ms response time
- Link management via a JSON file
- Expiring links
- Request logging
Try it out [here](https://i.adriank.dev/cloud-url)
## Deploying
Bootstrap:
```
npm i
cdk bootstrap
```
Deploy:
```
cdk deploy --context stage=main
```
🎉 You can now access links at: `https://{cloudfront_distribution_id}/{link_id}`
🔗 The console output will contain the URL of the CloudFront distribution which uses
the redirect viewer function.
🌍 The region is locked to us-east-1, as this allows us to configure the function log group
from the CDK.
⏳ CloudFront functions take ~5 minutes to deploy. The CDK deploy process is
synchronous, unlike the AWS console which processes function updates asynchronously.
📄 You can deploy multiple instances by altering the `stage` context value.
## Managing links
Update [`links.json`](./links.json) and deploy!
Links can be added either in the format:
```javascript
{
// Simple format, no expiration
"LINK_ID": "URL",
// Object format, with optional expiration
"LINK_ID": {
"url": "URL",
"expiresAt": "ISO8601 date"
}
}
```
## Tests
Run unit tests with `npm run test`
## License
[The Unlicense](./LICENSE)