Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/paulshpilsher/sqzsvc

URL Squeeze (shortner) Web API service
https://github.com/paulshpilsher/sqzsvc

gin go golang jwt

Last synced: about 1 month ago
JSON representation

URL Squeeze (shortner) Web API service

Awesome Lists containing this project

README

        

SQZSVC

---


Yet another URL shortner written in Go (Golang)


SQZSVC - provides back end REST services to support URL management frontend as well URL redirections.

## 📝 Table of Contents

- [About](#about)
- [Getting Started](#getting_started)
- [Deployment](#deployment)
- [Usage](#usage)
- [Built Using](#built_using)
- [TODO](../TODO.md)
- [Contributing](../CONTRIBUTING.md)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)

## 🧐 About

What is a URL shortener?
A URL shortener is a simple tool that takes a long URL and turns it into a shorter URL string.(e.g. instead of "http://www.thisisanextremelylongurltorememberandinconvinient.com/i/mean/it/is/really/long" turns it something like this "http://abc/xyz")

## 🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.

### Prerequisites

What things you need to install the software and how to install them.

```
Give examples
```

### Installing

A step by step series of examples that tell you how to get a development env running.

Say what the step will be

```
Give the example
```

And repeat

```
until finished
```

End with an example of getting some data out of the system or using it for a little demo.

## 🔧 Running the tests

Explain how to run the automated tests for this system.

### Break down into end to end tests

Explain what these tests test and why

```
Give an example
```

### And coding style tests

Explain what these tests test and why

```
Give an example
```

## 🎈 Usage

Add notes about how to use the system.

## 🚀 Deployment

Add additional notes about how to deploy this on a live system.

## ⛏️ Built Using

- [Postgres](https://www.postgresql.org/) - Database
- [Go](https://go.dev/) - Server Framework
- [Svelte](https://svelte.dev/) - Web Framework (yet to be coded)

## ✍️ Authors

- [@PaulShpilsher](https://github.com/PaulShpilsher) - Software engineer and digital nomad

## 🎉 Acknowledgements

- Inspiration ["Simple Made Easy" - Rich Hickey (2011)](https://www.youtube.com/watch?v=SxdOUGdseq4)
- References