Table of contents

• Getting Started
• Prerequisites
• Installation
  • Environment Variables
  • Starting the dev server
  • Running the tests locally
  • Starting the production server
• usage
  • Generating short url
  • Translating the short url

blty-url-shortener

Getting Started

To get a copy of this project up and running on your local machine for testing and development, you would need to have a minimum of the listed prerequisites installed on your local machine. To get a head start.

Prerequisites

You must have

1. Node.js (v8.12.0 or higher) and npm (6.4.1 or higher) installed on your local machine. Run node -v and npm -v in your terminal to confirm that you have them installed

2. GIT bash

installation

To get started, clone this repository on your local machine using the following steps:

Launch your terminal and navigate to the folder you want the project to be and enter the the following commands:

$ git clone -b main https://github.com/blty-url-shortener
$ cd blty-url-shortener
$ npm install

Environment Variables

Create a .env file and add the environment variables described in the .env.sample file.

Starting the dev server

npm run dev

Running the tests locally

npm test

Starting the production server

npm start

usage

The bity-url-shortener a Playgrounds interface at /graphiql. The query accept one required argument and two optional parameter,

• url - required : The url to be converted to a short url

• customName - optional : A 6-character name provided to be used to form a short url in place of a generated random string

• replace - optional : This can used if a custom name used to generate a short url exist. It is a boolean value which represent if an existing long url should be replace with the new one

Generating short url

Only the required url parameter is supplied

query {
  urlShortener(url: "https://replit.com/@Aijeyomah/ZealousWetParameter#index.js") {
    status
    message
    shortUrl 
  }
}

result

{
  "data": {
    "urlShortener": {
      "status": 200,
      "message": "Successfully shortened url",
      "shortUrl": "https://blty.herokuapp.com/PdrTKk"
    }
  }
}

The required url parameter and an optional custom name is supplied

query {
  urlShortener(url: "https://replit.com/@Aijeyomah/ZealousWetParameter#index.js", customName: "enyata") {
    status
    message
    shortUrl 
  }
}

result

{
  "data": {
    "urlShortener": {
      "status": 200,
      "message": "Successfully shortened url",
      "shortUrl": "https://blty.herokuapp.com/enyata"
    }
  }
}

Translating the short url

This redirects the short url to it's corresponding long url