krtk.rs

KO | EN

gitlite — search

#python #hacktoberfest #typescript #golang #machine-learning #rust #deep-learning #linux #docker #macos #nodejs #java #windows #security

(★ 19)

My Rust 🦀 powered Link shortener.

krtk.rs Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# krtk-rs: A Serverless URL Shortener

`krtk.rs` is a high-performance, serverless URL shortener built with Rust and AWS CDK. Running fully AWS.

> ⚠️ THIS IS NOT PRODUCTION READY ⚠️
> There is no authentication implemented yet. So feel free to explore this project and tinker with it, but it would be unwise to implement this in any sort of production capacity. You have been warned.

This project demonstrates the integration of Rust-based Lambda functions with AWS services like API Gateway, DynamoDB, and CloudFront to create a scalable and responsive web application. The infrastructure is defined as code using AWS CDK, enabling easy deployment and management.

Huge shout out to [Luciano](https://www.linkedin.com/in/lucianomammino/) and [James](https://www.linkedin.com/in/james-eastham/) for making the [Crafing Lambda Functions in Rust book](https://rust-lambda.com/) which enabled me to build this. 👏

## Repository Structure 🗃️

```
.
├── bin
│   └── krtk-rs.ts              # CDK app entry point
├── lambda
│   ├── create_link             # Lambda function for creating short links
│   ├── get_links               # Lambda function for retrieving links
│   └── visit_link              # Lambda function for handling link visits
│   └── process_analytics       # Lambda function for analytics processing 
├── lib
│   ├── certificate-stack.ts    # Stack for SSL certificate
│   └── krtk-rs-stack.ts        # Main infrastructure stack
├── shared                      # Shared Rust code
├── website                     # Frontend assets
│   ├── assets
│   │   └── main.js             # Frontend JavaScript
│   └── index.html              # Main HTML page
└── test
    └── krtk-rs.test.ts         # Tests for the CDK stack (not yet implemented)
```

## Look and feel

![Screenshot of krtk.rs](https://raw.githubusercontent.com/darko-mesaros/krtk.rs/main/img/screen.png)

## Usage Instructions

### Prerequisites 📋

- Node.js (v14 or later)
- AWS CLI configured with appropriate credentials
- Rust (latest stable version)
- AWS CDK CLI (v2.177.0 or compatible)

### Installation 💾

1. Clone the repository:
   ```
   git clone https://github.com/your-repo/krtk-rs.git
   cd krtk-rs
   ```

2. Install dependencies:
   ```
   npm install
   ```

3. Build the project:
   ```
   npm run build
   ```

### Deployment 🚀

1. Bootstrap your AWS environment (if not already done):
   ```
   cdk bootstrap
   ```

2. Deploy the stacks:
   ```
   cdk deploy --all
   ```

This will deploy two stacks:
- `CertificateStack`: Creates an SSL certificate for the domain
- `KrtkRsStack`: Deploys the main application infrastructure

### Using the URL Shortener 🔥

After deployment, you can use the URL shortener by:

1. Navigating to the deployed website URL (krtk.rs)
2. Entering a long URL in the input field
3. Clicking "Shorten" to generate a short link
4. Using the generated short link to access the original URL

## Data Flow 🔂

1. User submits a URL to be shortened:
   - Frontend JavaScript sends a POST request to `/api/links`
   - `create_link` Lambda function processes the request (tries to get the Website title, and image)
   - New short link is stored in DynamoDB
   - Response with short link ID is sent back to the user

2. User visits a short link:
   - Request is routed through CloudFront to API Gateway
   - `visit_link` Lambda function looks up the original URL in DynamoDB and returns the original link.
   - The realtime log is sent from *CloudFront* to a Kinesis stream.
   - The `process_analytics` function increments the visit count.

3. Retrieving list of links:
   - Frontend JavaScript sends a GET request to `/api/links`
   - `get_links` Lambda function queries DynamoDB for all links
   - Response with list of links is sent back and displayed on the frontend

```
            [Kinesis] ------------------------+
                ^                             |
                |                             v
[User] -> [CloudFront] -> [API Gateway] -> [Lambda] <-> [DynamoDB]
  ^           |
  |           v
  +--- [S3 (Static Website)]
```

![Architecture diagram of krtk.rs](https://raw.githubusercontent.com/darko-mesaros/krtk.rs/main/img/arch.png)

## Infrastructure 🏗️

The project uses AWS CDK to define and deploy the following resources:

- Lambda:
  - `createLink`: Creates new short links
  - `getLinks`: Retrieves list of links
  - `visitLink`: Handles link visits and redirects
  - `processAnalyticsLambda`: Handles the CF access logs from kinesis

- DynamoDB:
  - `linkTable`: Stores short link data

- S3:
  - `hostingBucket`: Hosts the static website files

- CloudFront:
  - Distribution for serving the website and API

- Kinesis:
  - Receving realtime acces logs from CloudFront

- API Gateway:
  - HTTP API for handling link operations

- Route53:
  - Hosted zone and records for custom domain

- ACM:
  - SSL certificate for the custom domain

## URL Validation

In order to use URL validation, you need to have an Google API Key set up, and the *Safe Browsing API* enabled in your Google Project. More info can be found [here](https://developers.google.com/safe-browsing/v4/get-started)

## TODO 📋

Here is the stuff that need to be implemented to make this project production-ready:

### Infrastructure Improvements 🏗️
- [ ] **Domain name as parameter**: Allow changing the TLD from `krtk.rs` to something else.
- [ ] **Create a DEV stage**: Currently, the PROD stage is very much dev-like. A dedicated DEV stage would be useful for testing.
- [ ] **Tag all resources**: Ensure all resources in the stack are properly tagged for better management.
- [ ] **Further break down stacks**: Consider having separate stacks for Lambda, data, etc., for better modularity.

### Feature Enhancements 🚀
- [ ] **Handle blocked websites**: Improve handling when scraping website titles and images, especially when blocked by Cloudflare or other protections.
- [ ] **Implement Auth**: Use [Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools.html) to add authentication.
- [x] **Shorter links**: Investigate ways to generate shorter URLs (e.g., shorter UUIDs or custom short codes).

### Front End ✨
- [x] **Order links by creation**: Figure out how to order retrieved links by date created.
- [x] **Pagination**: Implement pagination for the front end.

### Documentation & Testing 📚
- [ ] **Add tests for CDK stack**: Currently, the tests for the CDK stack are not implemented.
- [ ] **Improve documentation**: Add more detailed documentation for deployment, usage, and troubleshooting.

### Future Ideas 💡
- [ ] **Analytics**: Add basic analytics to track link usage (e.g., number of clicks, geographic data).
- [ ] **Custom domains**: Allow users to use custom domains for their shortened links.

### HTMX 🌐
- [x] **Optimize for HTMX**: Instead of returning JSON, I should have the ability to return pure HTML and have it just handled by HTMX

krtk.rs

krtk.rs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

krtk.rs

krtk.rs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README