elia/shortenit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
The personal URL shortener
9 commits 2 branches 0 tags 50 KiB
Python 83.5%
HTML 16.5%
Find a file
Elia El Lazkani db07547ecb Adding more information to the README
2019-11-01 19:51:45 +01:00
config Adding the ability to choose upper or lower case ID generation 2019-10-13 16:42:49 +02:00
requirements Migrated the ID generation system for security reasons. 2019-10-13 16:19:32 +02:00
shortenit Adding the ability to choose upper or lower case ID generation 2019-10-13 16:42:49 +02:00
.gitignore Migrated the ID generation system for security reasons. 2019-10-13 16:19:32 +02:00
LICENSE Add LICENSE 2019-10-07 22:07:37 +00:00
README.rst Adding more information to the README 2019-11-01 19:51:45 +01:00
setup.py Committing initial draft of shortenit 2019-10-02 21:30:42 +02:00

README.rst 

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