https://github.com/putuwaw/shorten-url

URL Shortener using Flask, Tailwind CSS, and MySQL
https://github.com/putuwaw/shorten-url

collaborate flask mysql tailwindcss url-shortener vercel

Last synced: 4 months ago
JSON representation

URL Shortener using Flask, Tailwind CSS, and MySQL

• Host: GitHub
• URL: https://github.com/putuwaw/shorten-url
• Owner: putuwaw
• License: mit
• Created: 2023-01-01T10:12:22.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-06T01:04:00.000Z (about 2 years ago)
• Last Synced: 2024-05-06T02:26:39.171Z (about 2 years ago)
• Topics: collaborate, flask, mysql, tailwindcss, url-shortener, vercel
• Language: HTML
• Homepage: https://shrtn-url.vercel.app
• Size: 121 KB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ![](static/images/logo.svg) Shorten URL

![Flask](https://img.shields.io/badge/Flask-000000?style=for-the-badge&logo=flask&logoColor=white)

![MySQL](https://img.shields.io/badge/MySQL-005C84?style=for-the-badge&logo=mysql&logoColor=white)

![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white)

Shorten URL is a free, simple, and open-source URL shortener. It is a web based application that allows you to shorten your long URLs.

## Features 💡

Using Shorten URL, you can:

- [x] Shorten your long URLs.

- [x] Create custom short URLs.

## Prerequisites 📋

- Python 3.10 or higher

- MySQL 8.0.32 or higher

- Node.js v18.13.0 or higher

- Docker 24.0.4 or higher (optional)

- docker-compose 1.29.2 or higher (optional)

## Installation 🛠

### Manual Installation

- Clone the repository:

```bash

git clone https://github.com/putuwaw/shorten-url.git

```

- Install the requirements:

```bash

make init

make install

```

- Create .env file and set the environment variables for database connection:

```bash

make env

```

- Install Tailwind CSS, configure it, and watch for changes:

```bash

make tw-install

make tw-watch

```

- Run the application:

```bash

make run

```

### Docker Installation

- Clone the repository:

```bash

git clone https://github.com/putuwaw/shorten-url.git

```

- Run docker-compose:

```bash

docker-compose up

```

## Contributing 🤝

Contributions are welcome! Please read the [contributing guidelines](CONTRIBUTING.md) first.

## License 📝

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.