Git Product home page Git Product logo

littlelink's Introduction

LittleLink

tests

It shrinks your link

Stack

  • TypeScript
  • serverless
  • serverless-offline
  • mongodb-memory-server
  • webpack
  • mongoose
  • eslint
  • jest
  • prettier
  • husky
  • Github Actions
  • snyk

How-to

  1. Add a link

    POST /hash
    body { url: "example.com" }
    

    response

    {
      "hash": "fkwKwr"
    }
  2. Get a link by hash

    GET /url?hash=fkwKwr
    

    response

    {
      "url": "example.com"
    }
  3. Get the statistics for URL

    POST /stats/url
    { url: "example.com"}
    

    response

    {
         "url": "example.com",
         "hashes": ["fkwKwr", "gown2s" ....],
         "ipAddresses": ["1.1.1.1", "8.8.8.8", ....],
         "requests": 1 // how many times this URL has been fetched, regardless of hash
    }
  4. There's a cronjob which will delete unused links in the past year every day at 12.00am.

Development

  1. clone it
  2. run yarn
  3. rename .env.example to .env
  4. replace the value of MONGO_URI

Deployment to AWS

  1. Make sure you have AWS CLI configured
  2. Make sure the AWS IAM user you have configured in AWS CLI has permissions for Lambda, IAM, S3, CloudWatch, API Gateway and CloudFormation
  3. Make sure you replaced MONGO_URI with a correct one
  4. run sls deploy. Or change the deploy-sls script and run that

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.