elia/shortenit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Adding more information to the README

Browse source
This commit is contained in:
Elia El Lazkani 2019-11-01 19:43:19 +01:00
parent 126af19e87
commit db07547ecb
1 changed files with 23 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.rst
View file

@ -1,6 +1,26 @@
shortenit
Shortenit
=========
shortenit is a tool to shorten urls.
Shortenit is a tool to shorten urls.
NOTE: This is a very early draft project. Contributions are welcome.
**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