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 go-cache for faster redirections and fewer database calls, by caching the results of redirecting requests.
-
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 from: Turso Docs. Only needed if you're going to run the server in
prodmode else the server would create a temporarysqlite3database in the project directorycp .env .env.local
-
Install the dependencies:
go mod tidy
-
Run the server:
go run . -
Access the web interface on port:
1920:xdg-open http://localhost:1920
Use the make command to run/build the web server.
Note
Make sure the ENVIROMENT variable in .evn.local is set to dev in order run the server in development mode.
Tools you'll be needing for development:
- Watchexec - A file watcher for restarting and running the web server when the source files are updated.
- Sqlc - Generating type-safe code from SQL.
- Bun - Bun package manager (or
npm,pmpm) for JavaScript dependencies. - Node - For live-reloading web pages whenever the source files changes.
make serverto start the server in watch modemake tailwindto watch for tailwind classesmake tailminito minify the generated tailwind CSS filemake sqlcto generate type safe SQL Go-code.
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