clickntrack 0.0.2.dev3

Click & Track services - REST API for short URL handling

Multi-domain permalink management engine. -

Click’n’Track provides simple REST API to manage permalinks with multi-domain web hosts capabilities.

Every permalink is defined by a hostname and a single path segment and a target URL. Hostname and path segment compose the permalink URL regardless the protocol scheme.

For instance, using the default hostname from domain mydomain.io and clickntrack you can compose permalink URLs http:\mydomain.io\clickntrack or https:\mydomain.io\clickntrack depending on the web host configuration.

When activating a permalink, Click’n’Track engine lookups at the database to retrieve the target URL, store few ‘hit’ data et redirect the HTTP client to the target URL using an HTTP 302 response.

For every ‘hit’, Click’n’Track grabs some basics data like the timestamp, the user-agent, the referer and the remote address of the client.

DISCLAIMER

Click’n’Track is not an enterprise class application: You run it in production at your own risk.

Click’n’Track is a sandbox project, I develop to learn Python programming and to discover MongoDB capabilities.

REST API

TODO: Coming soon !

INSTALLATION NOTES

Software requirements

• MongoDB database

• Python 3.5+ runtime with dependencies on

  • PyMongo

  • Bottle framework

  • Monkey IoC

  • Monkey DAO PyMongo

Setup recommendations

As MongoDB engine, we recommend to use the MongoBD Atlas platform.

Unless Click’n’Track can run standalone, we recommend to the application a WSGI compliant web server like Apache HTTP server on a Linux server. When hosting Click’n’Track on an Apache HTTP server, it is required to enable mod_wsgi.

Configuration

TODO: Coming soon !

Running Click’n’Track standalone

TODO: Coming soon !