Logo

ltsNinja

Simple and lightwell url shortener running GO.

Explore demo · Report Bug · Pull request

Table of contents
  1. What is ltsNinja ?
  2. Getting started
  3. Roadmap
  4. License
## What is ltsNinja Homepage | Dashboard :-------------------------:|:-------------------------: ![](https://i.imgur.com/Ykjbxr6.png) | ![](https://i.imgur.com/8vhIrax.png) ltsNinja is a public, self-hosted tool that makes it easy to shorten urls. It's very lightweight and intuitive, which means it runs with very little performance. Few key points: * Github login for custom links * Easy dashboard for users

(back to top)

### Built With This section list major frameworks/libraries used * ![](https://img.shields.io/badge/GO-20232A?style=for-the-badge&logo=go) * ![](https://img.shields.io/badge/Gin-20232A?style=for-the-badge&logo=gin) * ![](https://img.shields.io/badge/SqLite-20232A?style=for-the-badge&logo=sqlite&logoColor=blue) * ![](https://img.shields.io/badge/GitHub%20OAUTH-20232A?style=for-the-badge&logo=github) * ![](https://img.shields.io/badge/TailWind-20232A?style=for-the-badge&logo=tailwindcss)

(back to top)

## Getting Started Now let's see how to set up an ltsNinja instance. ### Installation 1. Create directory ```sh mkdir /opt/ltsNinja cd /opt/ltsNinja ``` 2. Download the latest release ```sh wget -O ltsNinja https://github.com/itsmrval/ltsNinja/releases/download/0.1.0/ltsNinja_linux_amd64 ``` 3. Download the example env ```sh wget -O .env https://github.com/itsmrval/ltsNinja/releases/download/0.1.0/example.env ``` 4. Complete `.env` * GITHUB_CLIENT_ID & GITHUB_CLIENT_SECRET with your [Github app](https://github.com/settings/developers) * GITHUB_REDIRECT_URL replacing the APP URL 6. Run it ```js chmod +x ltsNinja ./ltsNinja ```

(back to top)

## Roadmap - [x] URL Shortener - [x] Custom links - [x] User dashboard - [x] Edit with github - [ ] Admin dashboard

(back to top)

## License Distributed under the MIT License. See `LICENSE.txt` for more information.

(back to top)