Skip to content

PacketFire/pfurl.me

Repository files navigation

pfurl.me

Build Status

Description

Pfurl is a url shortening API designed to be easily used with curl. A user interface is also included via /up route for ease of use if curl is not an option.

The website: http://pfurl.me

Dependencies

  • Docker + Compose
  • Python 3.6+

Building

$ git clone https://github.com/PacketFire/pfurl.me
$ cd pfurl.me ; make setup ; make pip-install

Initialize Docker containers which will install Postgres and Flyway DB

$ docker-compose up postgres
$ docker-compose run flyway-migrate

API Usage

The API can be called via the curl command, if executed correctly a shortened url will be returned.

Example: curl -X POST -d '{"url": "http://yourlongurlhere.com"}' -H 'Content-Type: application/json' pfurl.me