sn0rt

The World's Best URL Snortener™ 🐷

Why have long URLs when you can have short ones? We snort 'em down to size! Because nobody has time for 47-character URLs when 8 will do.

• JDK 21 - Because we're fancy like that
• PostgreSQL - For storing all your glorious snorts (or use Docker Compose)
• Maven - The wrapper is included, you're welcome

Start the application with live reload (snort reloading?):

./mvnw quarkus:dev

Boom! 💥 Your snortener is now running at:

• 🏠 Homepage: http://localhost:8080 - The fabulous landing page
• 👑 Admin Panel: http://localhost:8080/admin - Where the magic happens (default: admin/admin)
• 🛠️ Dev UI: http://localhost:8080/q/dev/ - For the curious minds
• 📚 API Docs: http://localhost:8080/swagger-ui - Because documentation matters

Pro tip: Don't use the default admin/admin credentials in production. That's just asking for trouble. 🙈

Set your admin credentials via environment variables:

export ADMIN_USERNAME=your-username
export ADMIN_PASSWORD=super-secret-password

Or configure in application.properties:

sn0rt.admin.username=your-username
sn0rt.admin.password=super-secret-password
sn0rt.base-url=https://your-domain.com

./mvnw package
docker build -f src/main/docker/Dockerfile.jvm -t sn0rt:latest .

docker run -p 8080:8080 \
  -e ADMIN_USERNAME=admin \
  -e ADMIN_PASSWORD=secure-password \
  -e QUARKUS_DATASOURCE_JDBC_URL=jdbc:postgresql://host.docker.internal:5432/sn0rt \
  -e QUARKUS_DATASOURCE_USERNAME=postgres \
  -e QUARKUS_DATASOURCE_PASSWORD=postgres \
  sn0rt:latest

We've got CI/CD! Every push to main automatically builds and publishes a fresh Docker image:

docker pull ghcr.io/d135-1r43/sn0rt:latest

./mvnw test

All tests follow the Given-When-Then pattern. We're civilized here. 🎩

./mvnw package

./mvnw package -Dquarkus.package.jar.type=uber-jar
java -jar target/*-runner.jar

Want blazing-fast startup and tiny memory footprint? Go native!

./mvnw package -Dnative

No GraalVM? No problem! Build in a container:

./mvnw package -Dnative -Dquarkus.native.container-build=true

Run your lightning-fast native snortener:

./target/sn0rt-1.0.0-SNAPSHOT-runner

Note: Native builds can take a while. Perfect time for a coffee break ☕

Option 1: The Clicky Way 🖱️ Just go to http://localhost:8080/admin and use the fancy web form.

Option 2: The Cool Way 😎

# Let us pick a random code for you
curl -X POST http://localhost:8080/shorten \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/very/long/url"}'

# Be fancy with a custom code
curl -X POST http://localhost:8080/shorten \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/very/long/url", "customCode": "my-awesome-link"}'

curl -L http://localhost:8080/{shortCode}

It redirects! Like magic! ✨

curl http://localhost:8080/stats/{shortCode}

curl -u admin:admin http://localhost:8080/admin/qr/{shortCode}/pdf -o qr-code.pdf

Perfect for printing and sticking on everything! 📄

Built with love and these awesome technologies:

Found a bug? Want to add a feature? Have a hilarious idea for the copy?

Contributions are welcome! Please feel free to submit a Pull Request. Just remember:

• Keep it snorty 🐷
• Follow the Given-When-Then test pattern
• Make it fabulous ✨

This project uses the Quarkus framework under the Apache License 2.0.