Welcome to Linky, a simple yet powerful URL shortening application designed for those who value efficiency and ease of use. This project allows you to shorten long URLs quickly and effectively, making sharing links a breeze.
- Minimalist Design: Focus on what matters—shortening URLs.
- Self-Hosted: Run Linky on your own server for complete control.
- Fast Performance: Built with speed in mind, using
better-sqlite3for efficient database interactions. - Easy to Use: Simple interface that anyone can navigate.
- Analytics: Track the number of clicks on your shortened links.
- Custom Short Links: Choose your own short link for better branding.
To get started with Linky, follow these steps:
-
Clone the Repository:
git clone https://github.com/Dannjader/linky.git cd linky -
Install Dependencies: Make sure you have Node.js installed. Then run:
npm install
-
Run the Application: Start the application with:
npm start
For a downloadable version, visit the Releases section to find the latest release. Download the appropriate file, execute it, and follow the on-screen instructions.
Using Linky is straightforward:
- Open Your Browser: Navigate to the Linky app on your server.
- Enter a URL: Paste the long URL you want to shorten into the provided field.
- Click "Shorten": The app will generate a short link for you.
- Share Your Link: Copy the short link and share it wherever you need.
Linky leverages several technologies to deliver a seamless experience:
- Node.js: The runtime environment for building the application.
- Express.js: A web framework for building web applications in Node.js.
- better-sqlite3: A fast and efficient SQLite library for Node.js.
- SQLite: A lightweight database to store URL mappings.
- HTML/CSS: For the front-end interface.
We welcome contributions to Linky! If you would like to help improve the project, please follow these steps:
- Fork the Repository: Click the "Fork" button on the top right corner of the repository page.
- Create a New Branch:
git checkout -b feature/YourFeatureName
- Make Your Changes: Edit files and add your features or fixes.
- Commit Your Changes:
git commit -m "Add your message here" - Push to Your Branch:
git push origin feature/YourFeatureName
- Create a Pull Request: Go to the original repository and submit a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
For the latest releases, visit the Releases section. Here, you can download the latest version and find any updates or changes.
If you encounter any issues or have questions, feel free to check the Issues section of the repository or reach out to the community.
Thank you for your interest in Linky! We hope this URL shortening app makes your online sharing easier and more efficient. Your feedback and contributions are always welcome as we strive to improve the app.
Happy shortening! 🚀