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

https://github.com/prodev717/url-shortener

A simple full-stack URL shortener built with Flask, SQLite, TailwindCSS, and JavaScript.
https://github.com/prodev717/url-shortener

Last synced: 2 months ago
JSON representation

A simple full-stack URL shortener built with Flask, SQLite, TailwindCSS, and JavaScript.

Awesome Lists containing this project

README

        

URL Shortener

project-image

A simple full-stack URL shortener built with Flask SQLite TailwindCSS and JavaScript.

shieldsshieldsshieldsshieldsshieldsshieldsshields

πŸš€ Demo

![URL Shortener](demo.gif)

🧐 Features

Here're some of the project's best features:

* Shorten URLs – Convert long URLs into short easy-to-share links.
* Redirect to Original URL – Access the original URL using the short link.
* Database Storage – Uses SQLite to store URLs and their short IDs.
* Persistent URLs – Shortened URLs remain valid even after restarting the server.
* Fast & Lightweight – Minimal dependencies for quick performance.

πŸ› οΈ Installation Steps:

1. Clone the Repository

```
git clone https://github.com/prodev717/url-shortener
```

2. Navigate to the cloned directory

```
cd url-shortener
```

3. Install Required Dependencies

```
pip install -r requirements.txt
```

5. Run main.py

```
python main.py
```

6. Open http://localhost:8000 in browser.

🍰 Contribution Guidelines:

To contribute first fork the repository and clone it to your local machine. Create a new branch for your changes then make and test your modifications while following the project's coding style. Commit your changes with a clear message and push your branch to your fork. Afterward create a pull request with a description of your changes. Once it’s reviewed it will be merged.

πŸ’» Built with

Technologies used in the project:

* python
* SQLite
* flask
* html
* tailwind CSS
* JavaScript

πŸ›‘οΈ License:

This project is licensed under the MIT License