An open API service indexing awesome lists of open source software.

https://github.com/manlikenacho/sissors

URL shortener using Go
https://github.com/manlikenacho/sissors

golang mongodb oop redis

Last synced: about 2 months ago
JSON representation

URL shortener using Go

Awesome Lists containing this project

README

          

# Sissors
URL shortener using Go

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/manlikeNacho/Dice/blob/main/LICENSE)

A Url shortener in Go using MongoDb and Gin Framework.

## Table of Contents

- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [License](#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](https://golang.org/). 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](https://snip-j7nt.onrender.com/swagger/index.html) 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](https://bmc.link/nachoooo)
- [Other donation method]

## License

Sissors is licensed under the MIT License.