Shortenit
=========

Shortenit is a tool to shorten urls.

**NOTE**: This is a very early draft project. Contributions are welcome.

Running
-------

To run ``shortenit``, first we need to have a running database. Shortenit uses `CouchDB <https://couchdb.apache.org/>`_ as a database.
CouchDB can run as a docker container.

.. code:: text

          $ docker run -p 5984:5984 -d couchdb 


At this point, visit the local instance `link <http://localhost:5984/>`_ and create the user credentials configured in ``config/config.py``.

Once the database is up and running and the credentials have been created, shortenit can be ran.

.. code:: text

          $ pip install -e .
          $ shortenit