Coder Social home page Coder Social logo

url-shortener's Introduction

URL Shortener

URL Shortener app using NodeJS and Mongodb.

Features

  • Clean Architecture in Typescript
  • Tests with Jest
  • Shorten URL
  • Redirect to URL
  • Redis to cache redirects
  • Exposing API with Express
  • Postman Request Import
  • Fake/InMemory Database for Tests

API Example

Shorten long url

method: POST
endpoint: /shorten
body: {
    long_url: 'https://github.com/Iazzetta'
}
response: {
    statusCode: 200,
    data: {
        long_url: 'https://github.com/Iazzetta',
        short_url: 'www.us.com/bRtlBXhaW1N,
        expiresAt: '2022-09-23T20:00:00.000Z',
        createdAt: '2022-09-22T20:00:00.000Z'
    }
}

Redirect to long url

method: GET
endpoint: /bRtlBXhaW1N
redirect: 'https://github.com/Iazzetta'

Requirements

  • Docker

Configuration Enviroument Variables

Create the .env file in the project root and add the necessary variables below:

DATABASE_URL="mongodb://...."
PREFIX_URL="www.us.com/"
EXPIRATION_HOUR=24
REDIS_URL="redis://redis:6379"

Run Production

$ docker-compose up --build --scale url-shortener=5

Run Development

$ npm start

Test

$ npm test

url-shortener's People

Contributors

iazzetta avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.