ltsNinja

Simple and lightwell url shortener running GO.

Explore demo · Report Bug · Pull request

Table of contents

1. What is ltsNinja ?
   • Built with
2. Getting started
   • Installation
3. Roadmap
4. License

What is ltsNinja

Homepage	Dashboard

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

• 
• 
• 
• 
• 

(back to top)

Getting Started

Now let's see how to set up an ltsNinja instance.

Installation

1. Create directory

   mkdir /opt/ltsNinja
   cd /opt/ltsNinja
   

2. Download the latest release

   wget -O ltsNinja https://github.com/itsmrval/ltsNinja/releases/download/0.1.0/ltsNinja_linux_amd64
   

3. Download the example env

   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
   • GITHUB_REDIRECT_URL replacing the APP URL

5. Run it

   chmod +x ltsNinja
   ./ltsNinja
   

(back to top)

Roadmap

• URL Shortener
• Custom links
• User dashboard
• Edit with github
• Admin dashboard

(back to top)

License

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

(back to top)