https://github.com/Lynx-Shortener/Lynx

A fullstack application using the MEVN stack to shorten your URLs.
https://github.com/Lynx-Shortener/Lynx

docker links nodejs self-hosted url-shortener

Last synced: 5 months ago
JSON representation

A fullstack application using the MEVN stack to shorten your URLs.

• Host: GitHub
• URL: https://github.com/Lynx-Shortener/Lynx
• Owner: Lynx-Shortener
• License: mit
• Created: 2022-12-09T21:50:46.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-18T23:11:13.000Z (11 months ago)
• Last Synced: 2024-11-19T00:20:32.147Z (11 months ago)
• Topics: docker, links, nodejs, self-hosted, url-shortener
• Language: Vue
• Homepage: https://getlynx.dev
• Size: 1.52 MB
• Stars: 201
• Watchers: 3
• Forks: 21
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/funding.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
> [!WARNING]  

> Lynx will no longer have new features added to it as of 2024-06-19, read [the announcement](https://github.com/Lynx-Shortener/Lynx/discussions/155) for more information











    





    





    





    





    





# Lynx

![link list](https://cdn.jackbailey.dev/screenshots/lynx.png)

## About

A fullstack application using the MEVN stack to shorten your URLs.

I've tried a variety of URL shorteners but didn't find any with the functionality I wanted so I made my own.

My functionality I wanted:

-   Admin Interface

-   Option to redirect the root path

-   Simple UI

A mirror of this repository is available at [git.jackbailey.uk](https://git.jackbailey.uk/Lynx-Shortener/Lynx)

## Installation

Installation has moved to [the docs](https://docs.getlynx.dev/installation/installation).

## Development/Contribution

I'm actively using and trying to add features/fix bugs with Lynx, I'm just busy.

You're welcome to make a PR adding any features/fixing any issues and I'll merge them.

The Roadmap is accessible [here](https://github.com/orgs/Lynx-Shortener/projects/2)

## Naming

Each item including a slug, destination and id is called a [`Link`](src/db/models/link.js), the plural being links.

Each link has a `slug`, this is the path in the source url. `example.com/2dch89772`'s slug would be `2dch89772`.

Each item including a username and password is called an [`Account`](src/db/models/account.js), the plural being accounts.