restore index & readme

This commit is contained in:
Matthias Kretschmann 2016-04-13 22:50:42 +02:00
parent 727c8c54e0
commit 3e9d10e289
Signed by: m
GPG Key ID: BD3C1F3EDD7831FC
2 changed files with 76 additions and 43 deletions

View File

@ -1,49 +1,24 @@
![yourls](images/yourls-logo.png)
[YOURLS](http://yourls.org) — [![Build Status](https://travis-ci.org/YOURLS/YOURLS.png?branch=master)](https://travis-ci.org/YOURLS/YOURLS)
========
# krt.mn
**YOURLS** is a set of PHP scripts that will allow you to run <strong>Y</strong>our <strong>O</strong>wn <strong>URL</strong> <strong>S</strong>hortener. You'll have full control over your data, detailed stats, analytics, plugins, and more. It's free.
My own url shortener based on [yourls - Your Own URL Shortener](http://yourls.org/) ([Google Code](http://code.google.com/p/yourls/))
It has a public front page under http://krt.mn with the latest shortened url. The backend is a completely restyled interface based on the YOURLS default styles (which are quite ugly). Here's what it looks like in the admin area:
![](http://f.cl.ly/items/2M0C2N1z0q3S0J0O0c2J/krtmn-admin-screen.png)
Everything custom is happening in `/user`:
- `user/plugins/my-own-stuff/plugin.php` adds css file link and a bit more dynamically to the html `head`
- `user/css/krtmn.css` overwrites the default styles
Quick Start
-----------
To get started, check [yourls.org](http://yourls.org)!
Learn more tweaks in the [Wiki documentation](https://github.com/YOURLS/YOURLS/wiki/).
## License & Usage
As the original YOURLS you're free to do whatever you want with this. But using this without further modifications as your own url shortener is probably not a good idea.
Community news, tips and tricks
-------------------------------
* Read and subscribe to the [The Official YOURLS Blog](http://blog.yourls.org)
* Follow [@yourls](http://twitter.com/yourls)
* Subscribe to the [YOURLS User Newsletter](http://yourls.org/newsletter) (infrequent, low volume)
Keep track of development
-------------------------
* Follow [@yourls_dev](http://twitter.com/yourls_dev)
* Check [commit messages](https://github.com/YOURLS/YOURLS/commits/master)
* Check the [Road map](https://github.com/YOURLS/YOURLS/wiki/Road-Map)
Bug Tracker
-----------
__Before opening any issue, please search for existing issues and read the [Issue Guidelines](https://github.com/YOURLS/YOURLS/wiki/Bug-Report).__
Have a **new bug** to report? [Please open a new issue](https://github.com/YOURLS/YOURLS/issues/new?title=Issue+title+--+be+DESCRIPTIVE&body=Before%20any%20bug%20report%2C%20check%20you%20are%20using%20the%20LATEST%20release%20or%20the%20development%20branch.%20Make%20sure%20you%20have%20SEARCHED%20closed%20issues%20first.%20Read%20the%20GUIDELINES%20linked%20in%20the%20yellow%20notice%20box%20above.%20Now%20please%20DELETE%20these%20first%20lines.%0A%0A%0A%23%23%23%20Reproducible%20Bug%20Summary%20%0A%0A1.%20This%20is%20the%20first%20step%0A2.%20second%20step%0A3.%20etc...%0A%0AThis%20is%20a%20bug%20because...%0A%0A%0A%23%23%23%20Technical%20details%0A%0A*%20YOURLS%20version%3A%0A*%20PHP%20version%3A%0A*%20Any%20other%20useful%20information%20depending%20on%20context%20%28server%20version%2C%20mysql%20version%2C%20browser%20version%2C%20OS%20version...%29%0A).
Versioning
----------
For transparency, YOURLS will be maintained under the [Semantic Versioning](http://semver.org) principles as much as possible. Releases are numbered with the following format: `<major>.<minor>.<patch>` and the following guidelines:
* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes and misc changes bumps the patch
*[Release Archive](https://github.com/YOURLS/YOURLS/releases)*
License
-------
Free software. Do whatever the hell you want with it.
YOURLS is released under the [MIT license](LICENSE.md)
## Acknowledgements
Many thanks to:
- Ozh Richard ([@ozh](https://twitter.com/ozh)) for creating yourls
- Fort Awesome ([@fortaweso_me](https://twitter.com/fortaweso_me)) for creating the [Font Awesome icon font](http://fortawesome.github.com/Font-Awesome)

58
index.php Normal file
View File

@ -0,0 +1,58 @@
<?php
// Start YOURLS engine
require_once( dirname(__FILE__).'/includes/load-yourls.php' );
// Change this to match the URL of your public interface. Something like: http://your-own-domain-here.com/index.php
$page = YOURLS_SITE . '/index.php' ;
$items = yourls_api_stats( 'last', 1 );
?>
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>krt.mn</title>
<meta name="description" content="personal url shortener of web &amp; ui designer matthias kretschmann">
<meta name="viewport" content="width=device-width">
<link rel="stylesheet" href="user/css/h5bp.css">
<link href='//fonts.googleapis.com/css?family=Lato:100' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="user/css/krtmn.css">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="/apple-touch-icon-114x114-precomposed.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="/apple-touch-icon-72x72-precomposed.png">
<link rel="shortcut icon" href="/apple-touch-icon-precomposed.png">
<link rel="shortcut icon" href="/favicon.ico">
</head>
<body id="public">
<header>
<h1><i class="icon-bookmark"></i><a href="/admin">krt.mn</a></h1>
</header>
<article role="main">
<?php foreach( $items['links'] as $item ) { ?>
<p>Latest short url: <a href="<?php echo $item['shorturl']; ?>"><?php echo $item['shorturl']; ?> <span class="title"><?php echo $item['title']; ?></span></a></p>
<?php } ?>
</article>
<footer>
<p><small>personal url shortener of web &amp; ui designer <a href="http://mkretschmann.com">matthias kretschmann</a>. You should follow me on <a href="http://twitter.com/kremalicious">twitter</a>.</small></p>
<p><small>icon font <a href="http://fortawesome.github.com/Font-Awesome/">Font Awesome</a></small></p>
</footer>
<script>
var _gaq=[['_setAccount','UA-1441794-9'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>