Table of contents
-
What is ltsNinja ?
-
Getting started
- 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
1. Create directory
```sh
mkdir /opt/ltsNinja
cd /opt/ltsNinja
```
2. Download the latest release and apply permissions
```sh
wget -O ltsNinja https://github.com/itsmrval/ltsNinja/releases/download/0.1.0/ltsNinja_linux_amd64
chmod +x ltsNinja
```
3. Create the service on systemd
Write the file
```sh
nano /etc/systemd/system/ltsNinja.service
```
Complete and put the service file below:
```txt
[Unit]
Description=LTS Ninja service
After=network.target
[Service]
Type=simple
ExecStart=/opt/ltsNinja/ltsNinja
Environment="GITHUB_CLIENT_ID="
Environment="GITHUB_CLIENT_SECRET="
Environment="GITHUB_REDIRECT_URL=https:///callback"
Environment="DB_PATH=/opt/ltsNinja/database.db"
Environment="PORT=8080"
[Install]
WantedBy=multi-user.target
```
6. Reload systemd and run the service !
```sh
systemctl daemon-reload
systemctl enable --now 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)
