README
¶
~ GoShortrr ~
A fast, simple and powerful URL Shortener
⚠️ Disclaimer
This project is still in a very early state of development and future updates might include breaking changes to the API until the first stable release (v1.0.0).
What is GoShortrr?
The goal of this project is to provide a clean web dashboard as well as a fast and open REST API to shorten URLs (even headless, i.e. without the web dashboard). The RESTful API is supposed to give you an interface that is just as powerful as the web dashboard, so all the features of the web dashboard should have an open and documented API implementation. That enables you to use GoShortrr in other projects (for instance a blog or chat bot) to automatically create, delete manage and analyze shortlinks.
Features
Web Dashboard
GoShortrr ships with a nice and clean web dashboard that aims to give you a front-end implementation of all REST API features. It's build using React, so it's a SPA (single page application).
Screenshots coming soon!
REST API
As mentioned above, GoShortrr has a fast and open REST API that aims to provide an implementation of all of GoShortrr's features. The web dashboard itself utilizes this API, there is no such thing as an internal API.
API docs coming soon!
📦 Installation
If you want to host your own instance of GoShortrr, follow the instructions provided on the wiki page.
Third party dependencies
Back End
Front End
Copyright © 2021 Fabian Reinders (fabiancdng)
Directories