Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time

sleeky logo

Sleeky is a minimal interface package for use with YOURLS, an open source URL shortener. Sleeky adds a public interface and overhauls the backend (admin) interface. Using this theme you can create your own Bitly / URL shortening site or a shortening site for internal use at companies.

Sleeky is split into two parts - frontend and backend.

  • Frontend adds a public user interface. Use this for creating a branded URL shortener or shortening service.
  • Backend makes the YOURLS backend look a lot prettier and makes various administrative tasks easier.

Sleeky website & demo

Screenshots

Frontend Screenshot Backend Screenshot

Quick Start

  1. Get a YOURLS install up and running.
  2. Clone this repo.
  3. Move the contents of the sleeky-frontend directory to the root of your YOURLS installation.
  4. Open the frontend/config.php file and change the values to suit (Remember to setup reCAPTCHA). Sleeky frontend is now installed a ready
  5. Move the sleeky-backend folder to the user/plugins/ folder of your YOURLS installation.
  6. Activate the plugin in the YOURLS admin area (example.com/admin/plugins.php). The plugin will show as Sleeky Backend.
  7. Done. Sleeky is now installed

Documentation

Everything you need to know about Sleeky can be found in the Wiki! You can find that here

Help

Need a hand? I would love to help you out! Head over to my site. Alternatively, you could open an issue on GitHub or you could tweet me.

Versioning

Sleeky follows the principles of Semantic Versioning.

License

This code is released under the MIT License