Giters

UzairURK / linkSqueezer

This Java GUI application allows users to input long URLs and generate shorter, customizable ones for easy sharing. URLs are stored in a local database and can be retrieved using the shortened URL or user-defined alias. The app is fast, secure, and reliable, and uses Java and Java Swing for the GUI.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

LinkSqueezer 👉🔗

License

A simple Java GUI application that shortens URLs. This app allows users to input a long URL and generates a shorter, more manageable URL that can be easily shared with others. The application implements a custom URL shortening algorithm and validates the entered URL to ensure that it is a valid URL before attempting to generate a shortened URL. Users can store the shortened URL by providing a user-defined alias or keyword. The original and shortened URLs are stored in a local database file DB.csv.

image

Table of Contents 📜

Requirements

The project requires Java 20 to run.

Project Files Breakdown

Overall, this directory tree gives an overview of the organization and structure of the project's files and directories.

C:\USERS\BLACKROSE\DESKTOP\LINKSQUEEZER
├── .gitignore
├── build.xml
├── DB.csv
├── manifest.mf
├── README.md
├── SRS.md
├── dist
│   ├── DB.csv
│   ├── LinkSqueezer.jar
│   └── README.TXT
└── src
    ├── GUI
    │   ├── AboutFrame.form
    │   ├── AboutFrame.java
    │   ├── MainFrame.form
    │   └── MainFrame.java
    └── linksqueezer
        ├── Link.java
        ├── LinkSqueezer.java
        ├── LinkStorage.java
        └── Main.java

Here's a brief description of each file :

  1. README.md: This file is typically used as the main documentation file for a GitHub repository. It contains information about the project, its purpose, features, and how to use it. It may also contain instructions for contributing to the project or running it locally.

  2. SRS.md: This file is a Software Requirements Specification document. It outlines the functional and non-functional requirements for the project, as well as any constraints or dependencies that need to be considered during development.

  3. DB.csv: This file is a database file used by the LinkSqueezer project. It likely contains data related to links that have been saved or compressed using the LinkSqueezer software.

  4. Main.java: This file is the main driver class for the LinkSqueezer project. It likely contains the main method, which is the entry point for the application. It may also contain other methods and classes used to initialize the application and manage user input/output.

  5. LinkSqueezer.jar: This file is the executable JAR file for the LinkSqueezer project. It is typically exported from an IDE and can be run on any system with Java installed. It contains all of the compiled Java code necessary to run the application, as well as any dependencies required by the project.

Overall, these files represent the core components of the LinkSqueezer project, including its documentation, requirements, code, and data files.

How to Run🛠️

To install and run the app on your local machine, follow these steps:

  1. Make sure you are using java 20 (build and tested using this).
  2. Clone the repository:
git clone https://github.com/hussainashiqktk/linkSqueezer
  1. Open the project in Netbeans (tested on Apache Netbeans 17).
  2. Run the Main.java file located in the src/linksqueezer directory.
  3. Or you can directly run the jar file named LinkSqueezer.jar in dist directory.

Usage 🚀

image

  1. Enter the long URL in the input field provided.
  2. Give the alias/name for your reference.
  3. Click the "Squeeze" button to generate a shortened URL.
  4. The shortened URL will be displayed in the output field below the input fields. The history is stored in the DB.csv file.
  5. To copy the shortened URL to clipboard click the button Copy To Clipboard.

Contributing 🤝

Contributions, issues, and feature requests are welcome! Feel free to check out the issues page to see if your suggestion has already been made. If you have found a bug or have a feature request, please [open a new issue][(https://github.com/hussainashiqktk/linkSqueezer/issues/new)

License 📝

This project is licensed under the MIT license.

Made with ❤️ by :

About

This Java GUI application allows users to input long URLs and generate shorter, customizable ones for easy sharing. URLs are stored in a local database and can be retrieved using the shortened URL or user-defined alias. The app is fast, secure, and reliable, and uses Java and Java Swing for the GUI.

Languages

Language:Java 100.0%