https://github.com/oleggtro/shawty

a basic url shortener (and my attempt at golang)
https://github.com/oleggtro/shawty

go golang url-shortener

Last synced: 14 days ago
JSON representation

a basic url shortener (and my attempt at golang)

• Host: GitHub
• URL: https://github.com/oleggtro/shawty
• Owner: oleggtro
• Created: 2022-09-10T16:40:35.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-16T13:03:07.000Z (over 1 year ago)
• Last Synced: 2024-06-21T18:00:56.361Z (5 months ago)
• Topics: go, golang, url-shortener
• Language: Go
• Homepage:
• Size: 207 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


    
Shawty

    a basic url shortener



---

## Usage

### Server

Shawty needs a running postgres instance to work. You could either download and run the docker image from [ghcr](https://github.com/cloudybyte/shawty/pkgs/container/shawty) or use the [provided docker-compose config](https://github.com/cloudybyte/shawty/blob/main/docker-compose.yml)

⚠️ **__Note:__** Do **NOT** run the server without a reverse proxy in front of it. 
 Additionally: I cannot give any guarantees regarding the security of this project. __Run at your own risk.__

### CLI

Download the precompiled binary off of the releases section (or build it yourself), login and have fun.

### Utility Script

This script should only be needed for development. 

Its only dependency is [gum](https://github.com/charmbracelet/gum).


The script will help you sticking to conventions, building images and stuff (look it up if you want to know what it exactly does. Thats what you should do before running sth off the internet anyways).

Running it is super simple:

Just invoke `./util.sh` without any arguments. Navigation should be pretty self explanatory.