Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frikishaan/lynx
An open-source self-hosted link shortner. Built with Laravel, Filament and SQLite ❤
https://github.com/frikishaan/lynx
filamentphp laravel link-shortener open-source php self-hosted sqlite
Last synced: 6 days ago
JSON representation
An open-source self-hosted link shortner. Built with Laravel, Filament and SQLite ❤
- Host: GitHub
- URL: https://github.com/frikishaan/lynx
- Owner: frikishaan
- License: other
- Created: 2024-08-17T07:30:39.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-01-25T10:47:03.000Z (16 days ago)
- Last Synced: 2025-01-25T11:24:52.793Z (16 days ago)
- Topics: filamentphp, laravel, link-shortener, open-source, php, self-hosted, sqlite
- Language: PHP
- Homepage:
- Size: 1.2 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://github.com/frikishaan/lynx/actions/workflows/tests.yml)
## About Lynx
Lynx is a self-hosted link shortner application. It allows you to shorten, track, and manage links with ease.
It is built with SQLite, making it lightweight, easy to manage, and perfect for projects of any scale. No complex database setup required, it offers a hassle-free way to handle your links while ensuring reliability and performance.
## Features
- **Choice pages** - Create choice pages to allow users to navigate to multiple destinations from a single short URL, offering flexibility and boosting conversions.
- **Customizable slug** -Define meaningful, unique slugs for your short urls like _ac.me/help_ or _ac.me/shop_ etc.
- **Password protected links** - Secure your shortened links with passwords and ensure only authorized users can access the resource.
- **QR Code** - Automatically generate QR codes for every shortened link, simplifying access and sharing.
- **Teams** - Collaborate efficiently by creating teams, allowing shared access and management.
- **Custom domains** - Enhance branding by using multiple custom domains for your short links, providing flexibility and a customized experience for different audiences or campaigns.
- **Analytics** - Gain insights into link performance with detailed analytics, including click counts, geographic data, and device statistics.
## Requirements
- PHP >= 8.2
- Laravel >= 11.x
## Installing locally
Follow below steps to install it locally -
### Clone repository
```bash
git clone https://github.com/frikishaan/lynx.git
```
### Install dependencies
```bash
composer install
npm install
npm run build
```
### Run database migrations
Run the database migrations using the following command -
```bash
php artisan migrate
```
Optionally, seed the test data into the database using -
```bash
php artisan db:seed
```
### Create account
Use the following command to create a account in the system -
```bash
php artisan lynx:create-account
```
### Background tasks
Lynx handles the click analytics asynchronously using the Laravel's powerful [queue system](https://laravel.com/docs/queues). By offloading analytics to background tasks, Lynx maintains optimal performance for users while managing data processing in the background. To start processing the queue items run the following command -
```bash
php artisan queue:work
```
Note - For long-running workers in production, ensure you supervise them using a process manager like Supervisor or Laravel Horizon for better reliability.
### Scheduled Jobs
Lynx utilizes Laravel's [task scheduling system](https://laravel.com/docs/scheduling) to handle schduled jobs in the application.
Currently, Lynx includes a job which deletes the expired links in the system, provided they are marked for deletion. To run the scheduled jobs use the following command -
```bash
php artisan schedule:run
```
For continuous scheduling in production checkout the [Laravel's documentation](https://laravel.com/docs/scheduling#running-the-scheduler).
## License
[Lynx license](./LICENSE.md)