shlink-manager/README.md

50 lines
1.5 KiB
Markdown
Raw Normal View History

2023-10-21 20:50:52 +02:00
<div align="center">
<img src="https://raw.githubusercontent.com/rainloreley/shlink-manager/main/assets/icon/icon.png" alt="Shlink Manager logo" width="100px" style="border-radius: 50%"/>
2023-07-10 20:01:48 +02:00
# Shlink Manager
2023-06-26 23:40:05 +02:00
2023-10-21 20:50:52 +02:00
</div>
Shlink Manager is an app for Android to see and manage all shortened URLs created with [Shlink](https://shlink.io/)
<a href="https://play.google.com/store/apps/details?id=dev.abmgrt.shlink_app" target="_blank">
<img src="https://raw.githubusercontent.com/steverichey/google-play-badge-svg/master/img/en_get.svg" alt="Play Store download" width="30%"/>
</a>
2023-06-26 23:40:05 +02:00
2023-10-21 20:50:52 +02:00
## 📱 Current Features
2023-07-10 20:01:48 +02:00
✅ List all short URLs<br/>
✅ Create new short URLs<br/>
✅ Delete short URLs<br/>
✅ See overall statistics<br/>
✅ Detailed statistics for each short URL<br/>
✅ Display tags<br/>
✅ Display QR code<br/>
✅ Dark mode support<br/>
2024-01-28 22:55:28 +01:00
✅ Edit existing short URLs<br/>
2024-03-31 21:55:27 +02:00
✅ Quickly create Short URL via Share Sheet<br/>
2023-07-10 20:01:48 +02:00
2023-10-21 20:50:52 +02:00
## 🔨 To Do
2023-07-10 20:01:48 +02:00
- [ ] Add support for iOS (maybe in the future)
- [ ] add tags
2024-03-31 21:55:27 +02:00
- [ ] Add dynamic rule-based redirects system (Shlink v4.0.0)
2023-07-10 20:01:48 +02:00
- [ ] improve app icon
2024-01-28 22:55:28 +01:00
- [ ] Refactor code
2023-07-10 20:01:48 +02:00
- [ ] ...and more
2023-10-21 20:53:16 +02:00
## 💻 Development
2023-10-21 20:50:52 +02:00
First make sure you've installed [Flutter](https://flutter.dev/) and the necessary tools to build for Android/iOS (Android Studio/Xcode).
```bash
$ git clone https://github.com/rainloreley/shlink-manager.git
$ cd shlink-manager
$ flutter pub get
$ flutter run
```
2023-10-21 20:53:16 +02:00
## 📄 License
2023-07-10 20:01:48 +02:00
2023-10-21 20:50:52 +02:00
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details