-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added backed theme and reorganised repo structure
Signed-off-by: Flynn Tesoriero <flynn@flynntes.com>
- Loading branch information
Showing
63 changed files
with
2,546 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,3 +25,4 @@ yourls-infos.php | |
yourls-loader.php | ||
assets/.sublime-grunt.cache | ||
.htaccess | ||
node_modules |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,35 @@ | ||
![sleeky logo](assets/img/logo-small.png) | ||
[![sleeky logo](sleeky-frontend/assets/img/logo-small.png)](https://sleeky.flynntes.com) | ||
|
||
Sleeky is a minimal web interface designed for use with YOURLS, an open source piece of software that lets you create your own URL shortener. Using this theme you can create your own Bitly or just a ULR shortener site or anything really. | ||
Sleeky is a minimal interface package for use with [YOURLS](https://github.com/YOURLS/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. | ||
|
||
# [Demo](http://sleeky.flynntes.com) | ||
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. | ||
|
||
![screenshot](assets/img/screenshot1.png) | ||
[**Sleeky website & demo**](https://sleeky.flynntes.com) | ||
|
||
##Quick Start | ||
1. Clone the repo. | ||
2. Open config.php and change the values to suit. | ||
3. Save and upload all the sleeky files to your server | ||
# Screenshots | ||
![Frontend Screenshot](https://sleeky.flynntes.com/assets/img/slides/frontend.png) | ||
![Backend Screenshot](https://sleeky.flynntes.com/assets/img/slides/light_index.png) | ||
|
||
##Documentation | ||
## Quick Start | ||
1. Get a YOURLS install up and running. | ||
2. Clone this repo. | ||
2. Move the contents of the `sleeky-frontend` directory to the root of your YOURLS installation. | ||
3. Open the config.php file and change the values to suit. | ||
*Sleeky frontend is now installed a ready* | ||
4. Move the `sleeky-backend` folder to the `user/plugins/` folder of your YOURLS installation. | ||
5. Activate the plugin in the YOURLS admin area (`example.com/admin/plugins.php`). The plugin will show as Sleeky Backend. | ||
6. Done. Sleeky is now installed | ||
|
||
## Documentation | ||
Everything you need to know about Sleeky can be found in the Wiki! You can find that [here](https://github.com/Flynntes/Sleeky/wiki) | ||
|
||
##Help | ||
Need a hand? I would love to help you out! Head over to my [site](http://flynntes.com/contact). Alternatively, you could open an issue on GitHub or you could [tweet me](http://twitter.com/flynntes)... your choice. | ||
## Help | ||
Need a hand? I would love to help you out! Head over to my [site](http://flynntes.com/contact). Alternatively, you could open an issue on GitHub or you could [tweet me](http://twitter.com/flynntes). | ||
|
||
##Versioning | ||
## Versioning | ||
Sleeky follows the principles of [Semantic Versioning](http://semver.org/). | ||
|
||
#License | ||
## License | ||
This code is released under the [MIT License](https://github.com/Flynntes/Sleeky/blob/master/LICENSE.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Random Background | ||
================= | ||
This is a sample plugin, for illustration purpose. | ||
Don't modify this plugin. Instead, copy its folder | ||
and modify your own copy. This way, your code won't | ||
be overwritten when you upgrade YOURLS. |
Oops, something went wrong.