URL - Shortener

URL shortening is used with long URLs to establish shorter aliases. We call these shortened aliases "short links." When they enter these short links, users are redirected to the original URL. When viewed, typed, mailed, or tweeted, short links save a lot of room. Additionally, it is less common for users to mistype shorter URLs.

Requirements and Goals of the System

Requirements for Functional:

Our service should create a shorter and unique alias from it, provided a URL. This is called a short link. To be readily copied and pasted into applications, this connexion should be short enough.
Our service can guide them to the original connexion when users access a short link.
Optionally, users should be able to select a custom short connexion for their URL.
After a normal default timespan, ties will expire. It should be possible for users to determine the expiration period.

Requirements for Non-Functional:

The system should be extremely accessible. This is needed because all the URL redirects will start failing if our service is down.
With minimal latency, URL redirection should occur in real-time.
Shortened (not predictable) connexions should not be guessable.

Requirements Extended:

Analytics; e.g., how many times did a redirect occur? IP Addresses? Country?

Getting Started

The following steps walk through getting the application running. Before you start,

Clone the project
Install and set up the environment
Run the tests
Start the app

1. Clone the project

Navigate to your project's chosen parent directory, e.g. $ cd ~/Documents/assignment
Clone the project, e.g. git clone https://github.com/Indrajitnaiya09/url-shortner.git
Navigate into the project directory: $ cd url-shortner
Clone the project, e.g. git clone https://github.com/Indrajitnaiya09/url-shortner-front-end.git
Navigate into the project directory: $ cd url-shortner-front-end

2. Install and set up the environment

Go to config/enviroment/development.rb and config (line no 10) the value according to your setup (whitelist your ngrok url) for nrgok download and set-up please follow -> https://ngrok.com/download

config.hosts << 'fa88515f0a59.ngrok.io'

Make sure your Ruby version 2.7.1, Rails 6.0.3.4 and PostgreSQL 12 React 16.14.0 how to check?

$ ruby -v
$ rails -v
$ psql --version
$ npm view react version
$ bundle
$ rails db:create
$ rails db:migrate
$ rails db:seed

If there is any missmatch please open the link and follow the instruction.

Ruby installation -> https://gorails.com/setup/osx/10.15-catalina
PostgreSQL installation -> https://www.postgresql.org/
React set-up -> https://www.youtube.com/watch?v=00kXjx9k3Os

Go to config/database.yml and config the value according to your setup

3. Run the tests

Run rspec to run all the tests and make sure everything works.

If you just want to run a single test file you can pass the path to the file, either using rspec:

bundle exec rspec <path to test>

This can also be used with specific line number (running only that one test), for example:

bundle exec rspec spec/requests/urls_spec.rb 10

4. Start the app

$ cd url_shortner
$ rails s -p 4000
$ cd url-shortner-front-end
$ npm install
$ npm start

Indrajitnaiya09/url-shortner