SinTan1729/chhoto-url
SinTan1729/chhoto-url
1
0
Fork 0
mirror of https://github.com/SinTan1729/chhoto-url synced 2024-12-26 07:38:36 -06:00
Code Issues Releases Activity

Updated README

Browse source
This commit is contained in:
Sayantan Santra 2022-12-28 19:01:03 +05:30
parent 3aac41d3a7
commit 635d51a659
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -15,22 +15,22 @@ I've looked at a couple popular URL shorteners, however they either have
unnecessary features, or they didn't have all the features I wanted. unnecessary features, or they didn't have all the features I wanted.
# Features # Features
- Shortens URLs of any length to a fixed length, randomly generated string - Shortens URLs of any length to a fixed length, randomly generated string.
- (Optional) Allows you to specify the shortened URL instead of the generated - (Optional) Allows you to specify the shortened URL instead of the generated
one (Missing in a surprising number of alternatives) one (Missing in a surprising number of alternatives).
- Opening the fixed length URL in your browser will instantly redirect you - Opening the fixed length URL in your browser will instantly redirect you
to the correct long URL (you'd think that's a standard feature, but to the correct long URL (you'd think that's a standard feature, but
apparently it's not) apparently it's not).
- Provides a simple API for adding new short links - Provides a simple API for adding new short links.
- Counts number of hits for each short link in a privacy respecting way - Counts number of hits for each short link in a privacy respecting way
i.e. only the hit is recorded, and nothing else i.e. only the hit is recorded, and nothing else.
- Allows setting the URL of your website, in case you want to conveniently generate - Allows setting the URL of your website, in case you want to conveniently
short links locally generate short links locally.
- Links are stored in an SQLite database - Links are stored in an SQLite database.
- Available as a Docker container - Available as a Docker container.
- Backend written in Java using [Spark Java](http://sparkjava.com/), frontend - Backend written in Java using [Spark Java](http://sparkjava.com/), frontend
written in plain HTML and vanilla JS, using [Pure CSS](https://purecss.io/) written in plain HTML and vanilla JS, using [Pure CSS](https://purecss.io/)
for styling for styling.
# Bloat that will not be implemented # Bloat that will not be implemented
- Tracking or spying of any kind. The only logs that still exist are - Tracking or spying of any kind. The only logs that still exist are