Git Product home page Git Product logo

shorting-url's Introduction

Appetito

Coding challenge

The problem:

Task: Shortening URL:

  • High level design for a URL Shortening system such as goo.gl or bit.ly the idea is to design a service that would generate a shorter URl for the long URLS

The solution:

Focuses on Backend only

Functionalities through API:

  • Generate a short url
  • Redirect to the origin url if you tried to open the shorten link in browser

Technologies

Nodejs, Expressjs, MongoDB, Mongoose, Mocha, Sinon, Docker, Docker Compose

Technical descisions:

  • Most of the classes depends on the Single responsibility concept.
  • Generated unique key based bcrypt package.
  • Express, is a very lightweight web framework.
  • MongoDB one of the most famous document database.
  • Mocha, Sinon for unit testing.
  • Express generator, to generate a simple boiler plate

Linked:

https://www.linkedin.com/in/ahmed-elbassel/

API Documentation

localhost:3000/docs

Run App

  • Clone the repo, and go inside it then the below command, if the commands don't run, try it with sudo:
[email protected]:elbassel/shorting-url.git
cd shorting-url
docker-compose build
docker-compose up
  • Check localhost:3000/docs for API documentation

Run tests

npm run test

##Run Code coverage: Yoy can find the result under coverage folder

npm run coverage

shorting-url's People

Contributors

elbassel avatar

Watchers

 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.