Giter Club home page Giter Club logo

shurl's Introduction

Shurl

Shurl is URL shortener implemented with Elixir and Maru framework (test project).

Installation

The application requires Elixir 1.5 and OTP 20. To run application or tests locally without Docker add appropriate config to config/local for your database.

  • Install dependencies with mix deps.get
  • Setup database with mix ecto.setup
  • Run tests with mix test
  • Start application with mix run --no-halt

Now you can use the application at localhost:8888.

Or alternatively to run application install Docker Compose which supports Compose file format 3.x.

  • Build containers with docker-compose build
  • Run containers with docker-compose up

And now you can use the application at localhost:4000.

Usage

Available routes:

HTTP method Route Description
POST /link Create short code for URL
GET /link/:short_code Show URL by short code
GET /:short_code Go to URL by short code
GET /analytics/:short_code Show short code analytics

Examples

Request
curl -X POST -H "Content-Type: application/json" -d '{"url":"http://example.com/about/index.html?uid=<%token%>"}' 'http://127.0.0.1:4000/link'
Response
200 OK
{"status":"success","response":"/yfmFczV3"}
Request
curl -X GET 'http://127.0.0.1:4000/link/yfmFczV3'
Response
200 OK
{"status":"success","response":"http://example.com/about/index.html?uid=<%token%>"}
Request
curl -X GET 'http://127.0.0.1:4000/yfmFczV3/?token=test'
Response
302 Found
location: http://example.com/about/index.html?uid=test
Request
curl -X GET 'http://127.0.0.1:4000/analytics/yfmFczV3'
Response
200 OK
{"status":"success","response":{"total":1,"statistics":{"{\"accept\":\"*/*\",\"host\":\"127.0.0.1:4000\",\"user-agent\":\"curl/7.47.0\"}":1}}}

shurl's People

Contributors

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