.png)
7 hours ago
1
Modern URL Shortening & Content Sharing
Note: This project is in early development. Some features may require tinkering to work properly in your environment.
- URL Shortening: Create short, memorable links for any URL
- Code Snippets: Share code snippets with syntax highlighting
- File Sharing: Upload and share files securely
- Analytics: Track visits to your short links with detailed statistics
- Custom Authentication: Secure server-side authentication with JWT tokens
- User Dashboard: View your links, snippets, files, and analytics
- Account Management: Profile editing, password management, and profile pictures
- Expiration: Set links to expire after a specific time
- Node.js (v16 or later)
- npm or pnpm
- Wrangler CLI
- A Cloudflare account
git clone https://github.com/clarkhacks/RdRx.git
cd RdRx
npm install
# or
pnpm install
Follow the prompts to authenticate with your Cloudflare account.
npx wrangler d1 create rdrx-shorturls
This will output a database ID. Copy this ID for the next step.
npx wrangler r2 bucket create rdrx-files
npx wrangler kv:namespace create KV_RDRX
npx wrangler kv:namespace create KV_RDRX --preview
Copy the IDs from these commands for the next step.
Edit your wrangler.toml file to include the database, bucket, and KV namespace information:
name = "rdrx"
main = "src/index.ts"
compatibility_date = "2024-12-05"
compatibility_flags = ["nodejs_compat"]
[vars]
FRONTEND_URL = "http://localhost:8787"
[observability]
enabled = true
[triggers]
crons = ["0 0 * * *"]
[[d1_databases]]
binding = "DB"
database_name = "rdrx-shorturls"
database_id = "YOUR_DATABASE_ID" # Replace with your actual database ID
[[kv_namespaces]]
binding = "KV_RDRX"
id = "YOUR_KV_NAMESPACE_ID" # Replace with your actual KV namespace ID
preview_id = "YOUR_KV_NAMESPACE_PREVIEW_ID" # Replace with your actual preview ID
[[r2_buckets]]
binding = "R2_RDRX"
bucket_name = "rdrx-files"
Create a .dev.vars file in the project root with your configuration:
API_KEY="your-api-key-here"
API_KEY_ADMIN="your-admin-api-key-here"
# Authentication
JWT_SECRET="your-super-secret-jwt-key-here-make-it-long-and-random"
MAILGUN_DOMAIN="your-domain.com"
MAILGUN_API_KEY="key-1234567890abcdef1234567890abcdef"
FROM_EMAIL="[email protected]"
FRONTEND_URL="http://localhost:8787"
Create a file called schema.sql in the project root with the following content:
-- Create short_urls table
CREATE TABLE IF NOT EXISTS short_urls (
id INTEGER PRIMARY KEY AUTOINCREMENT,
shortcode TEXT NOT NULL UNIQUE,
target_url TEXT NOT NULL,
created_at TEXT NOT NULL,
creator_id TEXT,
is_snippet BOOLEAN NOT NULL DEFAULT 0,
is_file BOOLEAN NOT NULL DEFAULT 0
);
-- Create analytics table
CREATE TABLE IF NOT EXISTS analytics (
id INTEGER PRIMARY KEY AUTOINCREMENT,
shortcode TEXT NOT NULL,
target_url TEXT NOT NULL,
country TEXT,
timestamp TEXT NOT NULL
);
-- Create deletions table
CREATE TABLE IF NOT EXISTS deletions (
id INTEGER PRIMARY KEY AUTOINCREMENT,
shortcode TEXT NOT NULL,
delete_at INTEGER NOT NULL,
is_file BOOLEAN NOT NULL DEFAULT 0,
created_at TEXT NOT NULL
);
-- Create users table
CREATE TABLE IF NOT EXISTS users (
id INTEGER PRIMARY KEY AUTOINCREMENT,
uid TEXT NOT NULL UNIQUE,
email TEXT NOT NULL UNIQUE,
name TEXT NOT NULL,
password_hash TEXT NOT NULL,
salt TEXT NOT NULL,
created_at TEXT NOT NULL,
updated_at TEXT NOT NULL,
profile_picture_url TEXT
);
-- Create sessions table
CREATE TABLE IF NOT EXISTS sessions (
id INTEGER PRIMARY KEY AUTOINCREMENT,
session_id TEXT NOT NULL UNIQUE,
user_id TEXT NOT NULL,
created_at TEXT NOT NULL,
expires_at TEXT NOT NULL
);
Then run:
npx wrangler d1 execute rdrx-shorturls --file=./schema.sql
npm run dev
# or
pnpm dev
Visit http://localhost:8787 to see your application.
npm run deploy
# or
pnpm deploy
For production, set your environment variables in the Cloudflare Dashboard or using Wrangler:
npx wrangler secret put JWT_SECRET
npx wrangler secret put MAILGUN_API_KEY
# etc.
If you encounter authentication issues:
- Check that your JWT_SECRET is properly set in your environment variables
- Ensure cookies are being properly set (check browser dev tools)
- Verify that your R2 bucket is properly configured for profile picture uploads
- Check server logs for detailed error messages
If you encounter database issues:
- Verify your D1 database is properly configured in wrangler.toml
- Check that all tables were created successfully
- Try running the schema.sql file again to ensure all tables exist
If you encounter issues during deployment:
- Ensure your Wrangler CLI is up to date: npm install -g wrangler@latest
- Verify your Cloudflare authentication: npx wrangler whoami
- Check your wrangler.toml configuration
- Make sure all required environment variables are set
rdrx-shorturls/
├── src/ # Source code
│ ├── components/ # UI components
│ │ ├── auth/ # Authentication components
│ │ ├── layouts/ # Layout components
│ │ ├── pages/ # Page components
│ │ └── ui/ # UI components
│ ├── helpers/ # Helper functions
│ ├── middleware/ # Middleware functions
│ ├── routes/ # Route handlers
│ ├── utils/ # Utility functions
│ ├── index.ts # Entry point
│ └── types.ts # TypeScript types
├── test/ # Tests
├── .dev.vars # Development environment variables
├── package.json # Dependencies and scripts
├── tsconfig.json # TypeScript configuration
├── wrangler.toml # Wrangler configuration
└── README.md # This file
- npm run dev - Start the development server
- npm run deploy - Deploy to Cloudflare Workers
- npm run test - Run tests
- npm run cf-typegen - Generate TypeScript types for Cloudflare bindings
- npm run format - Format code with Prettier
The application uses a custom server-side authentication system with the following features:
- JWT Tokens: Secure authentication using JSON Web Tokens
- HTTP-Only Cookies: Tokens are stored in secure, HTTP-only cookies for maximum security
- Password Hashing: PBKDF2 with salt for secure password storage
- Account Management: Users can update their profile, change passwords, and upload profile pictures
- Email Integration: Password reset via email using Mailgun
This project is licensed under the MIT License - see the LICENSE file for details.
