https://github.com/fteem/shortenizer
Mountable URL shortener for you Rails app.
https://github.com/fteem/shortenizer
Last synced: 27 days ago
JSON representation
Mountable URL shortener for you Rails app.
- Host: GitHub
- URL: https://github.com/fteem/shortenizer
- Owner: fteem
- License: mit
- Created: 2014-10-17T08:14:19.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-10-27T05:42:13.000Z (over 11 years ago)
- Last Synced: 2025-10-09T05:43:11.160Z (8 months ago)
- Language: Ruby
- Homepage:
- Size: 805 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Shortenizer
Shortenizer is a tiny mountable URL shortener for your Rails application.
## Installation
* Install the gem by adding it to your Gemfile.
* Mount the engine by adding this to your routes file.
```ruby
mount Shortenizer::Engine => "/your-preferred-route"
```
* Run migrations
```ruby
rake db:migrate
```
## Usage
To shorten a link, visit:
```
http://your-app-host/your-preferred-route/shorten
```
To view all the routes that this engine has, run:
```
rake routes
```
## Customization
* If you want to change the style of the form, see the CSS classes used [here](https://github.com/fteem/shortenizer/blob/master/app/assets/stylesheets/shortenizer/application.css).
## To do
* Add the abiility for the shortener to be used only for authenticated users.
## Contributing
1. Fork it ( http://github.com/fteem/shortenizer/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request