https://github.com/jorgechato/short-url

Just a simple, yet effective toolset for personal use. I don't want to be tracked with shorten url servers.
https://github.com/jorgechato/short-url

Last synced: about 2 months ago
JSON representation

Just a simple, yet effective toolset for personal use. I don't want to be tracked with shorten url servers.

• Host: GitHub
• URL: https://github.com/jorgechato/short-url
• Owner: jorgechato
• Created: 2024-11-23T07:59:56.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-23T12:48:12.000Z (2 months ago)
• Last Synced: 2024-11-23T13:35:10.845Z (2 months ago)
• Homepage: https://jrg.tools
• Size: 1000 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SHORT URL Toolset

> [!WARNING]

> Set up the repository with the proper hooks. Run `pre-commit install` in the root directory of the repository.

## API

| Method | Endpoint | Description | Response | isPublic |

| --- | --- | --- | --- | --- |

| GET | `/{id}` | Redirects to the original URL | Redirect | :o: |

| POST | `/` *Body:* `{ "original": "string" }` | Creates a new short URL | `{ "short": "string", "original": "string" }` | :x: |

| DELETE | `/{id}` | Deletes the short URL | `{ "message": "string" }` | :x: |

| GET | `/search?query={string}` | Returns all short URLs matching the query | `[{ "short": "string", "original": "string", "hits": "number" }]` | :x: |

## Authentication

To authenticate use a signature ssh key. The key must be added to the repository secrets.

## Folder Structure

```sh

.

├── db # SQLite3 schema for short URLs and SSH Auth

├── docs # Documentation for the DB schema

├── src # Source code

└── tf # Terraform files for infrastructure and deployment

```