Skip to content

Helps you remove those fatty parts of your URL

Notifications You must be signed in to change notification settings

ydaniju/prun.er

Repository files navigation

Prun.er

Prun.er is a web app that allows you to shorten your ugly urls into beautifully short ones. Visit prun.er at: https://pruner.herokuapp.com

Getting Started

Clone or fork this repository or download the entire project as a zip package and run locally.

External Dependencies

Web application is written with Ruby using the Ruby on Rails framework.

To install Ruby visit Ruby Lang. [v2.3.0]

To install Rails visit Ruby on Rails. [v4.2.4]

Install RubyGems and Bundler to help you manage dependencies in your Gemfile.

Running the App

  1. Once you have Ruby and Rails installed, clone the repo by running

$ git clone https://github.com/ydaniju/prun.er.git

  1. Then run the following command to install gem dependencies:

$ bundle install

  1. Then run the following command to set up the database:

$ bundle exec rake db:migrate

  1. Once the command runs successfully, start the Rails server by running:

$ rails server

  1. To access the app, visit http://localhost:3000 in a web browser

Testing

  1. To test the web application, run the following command to carry out all tests:

$ bundle exec rake spec

  1. To view test descriptors, run the following command:

$ bundle exec rake spec -fd

Features

  1. User account activation

  2. Statistics available for shortened urls

  3. Registered user can edit, delete or dectivate urls

Limitations

  1. Redirection to other sites is not protected. Users are solely responsible for their links

  2. Prun.er presently have no means for user management beyond account creation

  3. The app is still undergoing testing for possible bugs.

  4. Password reset service hasn't been implemented

  5. Email authentication hasn't been implemented

  6. API web service for external users is not yet implemented

  7. App is still on heroku leading to longer urls

Contributing

  1. Fork it by visiting - https://github.com/ydaniju/prun.er/fork

  2. Create your feature branch

$ git checkout -b new_feature

  1. Contribute to code

  2. Commit changes made

$ git commit -a -m 'descriptive_message_about_change'

  1. Push to branch created

$ git push origin new_feature

  1. Then, create a new Pull Request

About

Helps you remove those fatty parts of your URL

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published