mehmetumit / dexus

Dynamic extensible URL shortener

dexus

---

About

Dexus is a URL shortener that provides you with the ability to extend it dynamically according to your needs. You can utilize existing adapters or implement your own adapters based on ports. Afterwards, you only need to inject these adapters in cmd/main.go. Contributions of any new adapters are welcome.

Usage

Using binary release

Precompiled binaries are available on the relases page.

Local Usage

# Clone the repository
git clone https://github.com/mehmetumit/dexus.git
# Change directory
cd dexus
# Build and run with make
make exec
# Or just build as "./build/dexus"
make build

Using Docker

# Clone the repository
git clone https://github.com/mehmetumit/dexus.git
# Change directory
cd dexus
# Build image with make
make docker-build
# Run image with make
make docker-run
# Or manually
docker run -p 8080:8080 dexus:latest

Development

# Live reload using 'entr'
make live-reload

# Run tests and get coverage
make test

# Run tests and get coverage with html output
make test-coverage-html

Configuration

Env Vars	Default Values
DEBUG_LEVEL	true
HOST	all interfaces
PORT	8080
READ_TIMEOUT_MS	1000 ms
WRITE_TIMEOUT_MS	1000 ms
CACHE_TTL_SEC	60 s
YAML_REDIRECT_PATH	configs/redirection.yaml

Contributing

Greatly appreciate contributions from the community. Your input, whether it's through code, documentation, bug reports, or suggestions, helps improve this project and make it even better.

License

This project is licensed under the GPLv3 License.