Trimly is a URL shortener which means it takes a long URL and makes it shorter.
- User Authentication
- Hashing Algorithm (MD5 + base64 URL Encoding + Random counter)
- API Testing
- Caching with go-cache
- [] Swagger Documentation
- Postman Documentation
go 1.17+
MongoDB
docker
- Clone project using:
git clone https://github/meshachdamilare/trimly.git
-
Create your env file named
your_env_name.env
, and write your env variables according tosample.env
in the projects root directory -
Run unit tests using:
go test -tags=unit ./...
- Start the server using:
docker-compose up
- View Postman documentation for the API at Postman link
- Trimly API is hosted on render Link