Sissors

URL shortener using Go

A Url shortener in Go using MongoDb and Gin Framework.

Table of Contents

• Introduction
• Features
• Installation
• License

Introduction

Sissors is a lightweight application that allows you to shorten url and retrieve them at a very fast rate.

Features

Some of the features Sissors are:

• Storing urls
• Shorten urls
• API
• Custom url

Installation

To get started with Sissors, you'll need to install it.

• You can do this by downloading the latest release from the releases page.
• You can also build it yourself by cloning this repository and running go build in the root directory. Ensure you have Go installed if you want to do this. If Go is not installed, you can download it from here. Prefer version 1.20 or higher, but it should work with older versions too.
• Or you can use our Dockerfile.
• Ensure supported environmental variables have been set or provide them to the Sissors executable via CLI.

API

Sissors has an API that can be used to interact with it. The API is documented in our OpenAPI spec.

Contributing

Contributions are welcome! Please read our contributing guidelines for more information.

Donations

If you like Sissors and want to support its development, you can donate to us using the following methods:

• Buy me a coffee
• [Other donation method]

License

Sissors is licensed under the MIT License.