gull/README.md

23 lines
542 B
Markdown
Raw Normal View History

2020-05-12 08:30:45 +02:00
# gull
A simple URL shortener made in Go
## Usage
### Docker
Pull the image and run.
```
docker run -d --name gull -v /gull-data/:/app/data/ -p 8081:8081 aeolyus/gull:latest
```
This will preserve any persistent data under `/gull-data/`. Change this as needed.
### From Source
2020-05-12 08:30:45 +02:00
```
git clone https://github.com/aeolyus/gull.git
cd ./gull
go get -d -v ./...
2020-05-12 08:30:45 +02:00
go run server.go
```
This will create a directory `./gull/data` where persistent data will be stored.
2020-05-13 21:20:16 +02:00
## Acknowledgements
Inspired by [mnml](https://github.com/liyasthomas/mnmlurl/)!