Born from the fusion of the words 'smol' and 'link. Smolink is URL shortening tool, crafted with a minimalistic user interface. Its clean UI was designed to reflect how it transforms ugly, long and cluttered URLs into URLs that are short, clean and visually appealing.
- Shorten long URLs into short, easy-to-share links
- Simple minimalistic user interface
- Copy button for easy sharing
- Backend: Flask & PostgreSQL
- Frontend: React
- Containerization: Docker
To install and run the Smolink server (Flask) locally, follow these steps:
-
Clone this repository:
git clone https://github.com/mespino4/smolink.git -
Navigate to the
flask-serverdirectory:cd smolink/flask-server -
Create a Python virtual environment: Windows
python -m venv <env_name>
Linux
python3 -m venv <env_name>
4. Activate the Python virtual environment:
Windows
<env_name>\Scripts\activate
Linux
source <env_name>/bin/activate
-
Install dependencies:
pip install -r requirements.txt -
Run the Flask server:
Windows
python run.py
Linux
python3 run.py
To install and run the Smolink client (React) locally, follow these steps:
-
In a second terminal navigate to the
react-clientdirectory:cd smolink/react-client -
Install dependencies:
npm install -
Run the React development server:
npm run dev -
Access Smolink in your web browser, usually at
http://localhost:5173/.
To shorten a URL, follow these steps:
- Open Smolink in your web browser.
- Enter the long URL you want to shorten in the input field.
- Click the "Shorten" button.
- Copy the generated short link and share it with others.
Homepage of the Smolink application
Shorten a URL with Smolink
A demonstration of how Smolink works.
This project is licensed under the MIT License.