Giter Club home page Giter Club logo

beebee's Introduction

BeeBee

BB-8

Requirements

BeeBee requires Elixir >= 1.2 and Redis >= 3.0.

Setup

  1. run mix deps.get
  2. run mix conform.configure
  3. edit the generated config/beebee.conf with your redis credentials
  4. run mix run --no-halt
  5. enjoy!

Usage

BeeBee exposes two API endpoints, POST /_add and GET /_stats.

POST /_add

Accepts:

{
  "url": "https://github.com", // URL to be shortened
  "short_tag": "github" // OPTIONAL short tag
}

If a short tag is omitted, one will be randomly generated for you.

Returns:

{
  "short_tag": "github" // Short tag now mapped to the provided URL
}

GET /_stats

Returns:

[
  {
    "short_tag": "github",
    "url": "https://github.com",
    "count": 0
  },
  // ...
]

Any other route will try and find a matching short tag, increment the count, and return a 301 to the provided URL.

A 404 with an empty body will be returned for missing short tags

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.