Skip to content

susanesho/pearlbits

Repository files navigation

Build Status Coverage Status Code Climate

Pearlbit

Application Features

Pearlbit is an easy-to-use URL shortener for generating shortened URLs from lengthy URLs passed in. It allows users pass in ugly, long URLs and generates short unique URLs that redirect to the original address.

Anonymous or registered users can generate short URLs from long URLs. However, only registered users can choose a custom shortened URL.

Pearbit allows unlimited number of URL-shortening for users, and provides click-statistics to enable registered users keep track of how many times shortened URL has been visited.

Pearlbit allows registered users to manage URLs seamlessly. A registered user could decide to set shortened URL to be inactive or delete URL altogether. The target of a shortened URL could also be changed easily by users who created them.

To use, visit https://p-bits.herokuapp.com/

Application Limitations

  • Profile management by users is not available yet

  • App still lives on heroku with a lengthy domain name

Installation

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

Using Pearlbit

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

$ git clone https://github.com/andela-oesho/pearlbit.git

Then run the following command to install gem dependencies:

$ bundle install

Then run the following command to set up the database:

$ rake db:migrate

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

$ rails server

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

Testing

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

$ bundle exec rake spec

To view test descriptors, run the following command:

$ bundle exec rake spec -fd

Contributing

Fork it by visiting - https://github.com/andela-oesho/pearlbit/fork

Create your feature branch

$ git checkout -b new_feature

Contribute to code

Commit changes made

$ git commit -a -m 'descriptive_message_about_change'

Push to branch created

$ git push origin new_feature

Then, create a new Pull Request

About

A Url Shortener App

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published