Code Monkey home page Code Monkey logo

micro-url's Introduction

micro-url

a url shortening microservice using express and redis.

Requirements

  • node 8 >
  • docker
  • yarn (optional)

Getting Started

  1. clone repo
  2. run docker-compose up to start redis. (note: redis port has been changed to 6380)
  3. run yarn && yarn start (note: yarn is just a personal preference, you can use npm)
  4. service will be running on localhost:3000 You can also run yarn test to run all tests

API

POST /generate

  • Data Params url - URL to shorten

  • Success Response:

    • Code: 200
      Content: { ok: true, id : 'fe14f', shortUrl : 'localhost:3000/fe14f', longUrl: 'example.com' }
  • Error Response:

    • Code: 400 Bad Request
      Content: { ok: false, message: 'invalid url: example' }

GET /:id

  • URL Params

    Required: id=[string]

  • Success Response:

    • Will redirect to long url
  • Error Response:

    • Code: 400 Bad Request
      Content: { ok: false, message: 'No url found with id: example' }

micro-url's People

Contributors

tengis617 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.