Shawty is a URL shortener built using Golang, Turso and HTMX. It provides a simple web interface for shortening URLs, tracking their usage, and offering statistics about shortened URLs.
-
Web UI with Golang's
html/template: A minimalistic web interface built using Go's standardhtml/templatepackage and Tailwind. -
URL Click Statistics: Keep track of how many times each shortened URL is accessed.
-
Caching: Using Memcached for faster redirections and fewer database calls, by caching the results of redirecting requests to the original URL.
-
Input Validation: Checks if the URL is a valid URL schema. It only allows
https://URLs. And also checks if the URL contains a valid TLD.
-
Clone the repository:
git clone https://github.com/wavly/shawty.git cd shawty -
Set ENV Variables: Get the database URL and Token: Turso Docs
cp .env .env.local
-
Install the dependencies:
go mod tidy
-
Start the
Memcachedlistener:memcached # default port is: 11211 -
Run the server:
go run . -
Access the web interface on port:
1234:curl -i http://localhost:1234/
Use the Makefile to run/build the web server.
- Watchexec - A file watcher for restarting and running the web server when the source files are updated.
- Bun - Bun package manager (or
npm,pmpm) for installing and watching static content for tailwind classes. - Sqlc - Generating type-safe code from SQL.
make serverto start the server in watch modemake tailwindto watch for tailwind classesmake tailminito minify the generated tailwind CSS file
We welcome any contributions to this project! For major changes, please open an issue first to discuss what you would like to change.
- Shawty is Licensed under MIT
![@github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=64&v=4){kind=small}