Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paulshpilsher/sqzsvc
URL Squeeze (shortner) Web API service
https://github.com/paulshpilsher/sqzsvc
gin go golang jwt
Last synced: about 6 hours ago
JSON representation
URL Squeeze (shortner) Web API service
- Host: GitHub
- URL: https://github.com/paulshpilsher/sqzsvc
- Owner: PaulShpilsher
- Created: 2023-01-15T14:40:25.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-14T05:52:11.000Z (almost 2 years ago)
- Last Synced: 2023-02-26T10:22:14.545Z (over 1 year ago)
- Topics: gin, go, golang, jwt
- Language: Go
- Homepage:
- Size: 80.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
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)
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")
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.
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
```
Add notes about how to use the system.
Add additional notes about how to deploy this on a live system.
- [Postgres](https://www.postgresql.org/) - Database
- [Go](https://go.dev/) - Server Framework
- [Svelte](https://svelte.dev/) - Web Framework (yet to be coded)
- [@PaulShpilsher](https://github.com/PaulShpilsher) - Software engineer and digital nomad
- Inspiration ["Simple Made Easy" - Rich Hickey (2011)](https://www.youtube.com/watch?v=SxdOUGdseq4)
- References