Skip to content
/ gimly Public

Short description for short url generator project ๐Ÿ˜Š

License

Notifications You must be signed in to change notification settings

murat/gimly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

15 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Gimly

img credit: https://www.pngegg.com

Gimly is a URL shortener service written in Golang. It's just a hobby project, so don't expect a lot of features. I'll add the necessary shortening service features if I have enough time to work on it.

Up & Running

git clone git@github.com:murat/gimly.git && cd gimly
go mod download
cd web && npm install && npm run build && cd ..
go run cmd/gimly/main.go
# or
air # you need to install it

Will listen :8080 port ๐Ÿคž

API Contracts

Run in Postman

Create a short url

echo '{"data":{"title":"Github","url":"https://github.com"}}' | http post :8080/api/url

{
    "data": {
        "url": {
            "title": "Github",
            "url": "https://github.com"
        },
        "short_id": "UrIRHQx9"
    }
}

Get list of urls

http :8080/api/url

{
    "data": [{
        "url": {
            "title": "Github",
            "url": "https://github.com"
        },
        "short_id": "UrIRHQx9"
    }...],
}

Get a short url

http :8080/u/UrIRHQx9

It will redirect with HTTP status 308 ๐Ÿคž

Cheers ๐Ÿป

About

Short description for short url generator project ๐Ÿ˜Š

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published