url-shortner's Introduction

URL Shortener

Setup

Clone the repository by running the following command

$ git clone [email protected]:chaharshivam/url-shortner.git

Now, go to the cloned directory

$ cd url-shortner

Install dependencies by running the following commands

$ yarn install --check-files
$ bundle i

Setup the database

$ rails db:create db:migrate db:setup

Now create a env file with ROOT_URL

$ touch .env
$ echo "ROOT_URL=http://localhost:3000" > .env

Now we can run the rake tasks as follows

$ URL=https://bigbinary.com/jobs bundle exec rake app:encode

$ SHORTURL=https://short.is/tkLo2367 bundle exec rake app:decode

Assignment 2 - Reactify App

App is deployed here

Design

urls table should have a boolean field pinned with a default value of false
The urls returned at index action are in the following order:
- Pinned urls in chronological order i.e. The latest pinned url is at the top
- Non-Pinned urls in chronological order but after the pinned urls

API

index:
  method: 'GET'
  path: '/'
  responses:
    200: Returns a list of urls
    404: Not Found
    422: Unprocessable Entity

create:
  method: 'POST'
  path: '/urls'
  parameters:
    url:
      original: 'original url e.g. https://bigbinary.com'
  responses:
    200: Returns the url with shortened link
    422: Unprocessable Entity

show:
  method: 'GET'
  path: '/urls/:slug'
  parameters:
    slug: unique slug
  responses:
    200: Returns the url object with original url
    404: Not Found

update:
  method: 'PUT'
  path: '/urls/:slug'
  parameters:
    slug: unique slug
    url:
      pinned: 'true/false'
  responses:
    200: Returns the updated url
    404: Not Found
    422: Unprocessable Entity

url-shortner's People

Contributors

Stargazers

Watchers

url-shortner's Issues

I think I had created an issue about ability to download the report

This report should be processed in the background.

Did I not assign that issue to you?

Name of the app

Please change the name of the app from "Ur.ly" to "Citly".

In case you are wondering why this issue is coming up, I'm trying to get this app to the state where I could show to the future interns what they need to build.

Recommend Projects