Skip to content

putuwaw/shorten-url

Repository files navigation

Shorten URL

Flask MySQL Vercel

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:

  • Shorten your long URLs.
  • 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:
git clone https://github.com/putuwaw/shorten-url.git
  • Install the requirements:
make init
make install
  • Create .env file and set the environment variables for database connection:
make env
  • Install Tailwind CSS, configure it, and watch for changes:
make tw-install
make tw-watch
  • Run the application:
make run

Docker Installation

  • Clone the repository:
git clone https://github.com/putuwaw/shorten-url.git
  • Run docker-compose:
docker-compose up

Contributing 🤝

Contributions are welcome! Please read the contributing guidelines first.

License 📝

This project is licensed under the MIT License. See the LICENSE file for details.