ltsNinja

Web interface to reduce long URLs to short extensions

Go to file

Valentin 3b29312a2b Create README.md		2024-08-02 13:51:43 +02:00
static/img	feat(dashboard) frontend & working	2024-08-02 11:16:54 +02:00
templates	fix(name) renaming	2024-08-02 11:26:42 +02:00
.gitignore	feat(dashboard) frontend & working	2024-08-02 11:16:54 +02:00
LICENSE	Initial commit	2024-07-10 13:54:19 +02:00
README.md	Create README.md	2024-08-02 13:51:43 +02:00
example.env	feat(env) example env	2024-08-02 12:00:50 +02:00
go.mod	fix(mod) renaming	2024-08-02 11:42:27 +02:00
go.sum	mv(all) moving repository	2024-07-10 16:10:20 +02:00
index.go	fix(logging) ehancing logging	2024-08-02 11:37:06 +02:00

README.md

ltsNinja

Simple and lightwell url shortener running GO.

Explore demo · Report Bug · Pull request

Table of contents

What is ltsNinja ?
- Built with
Getting started
- Installation
Roadmap
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

Create directory
```
mkdir /opt/ltsNinja
cd /opt/ltsNinja
```

Download the latest release

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

Download the example env

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

Complete .env
- GITHUB_CLIENT_ID & GITHUB_CLIENT_SECRET with your Github app
- GITHUB_REDIRECT_URL replacing the APP URL
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)