elia/shortenit
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
The personal URL shortener
18 commits 2 branches 0 tags 50 KiB
Python 83.5%
HTML 16.5%
Go to file
Elia el Lazkani b2ca72a809 chore(): Updates code to run on latest python 
* Updates setup.py to use the markdown file
* Replaces load() with safe_load()
2022-06-17 22:14:36 +02: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 chore(): Updates code to run on latest python 2022-06-17 22:14:36 +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.md Fixes configuration path 2021-03-20 12:03:57 +01:00
setup.py chore(): Updates code to run on latest python 2022-06-17 22:14:36 +02:00
TODO Appending TODO. 2019-11-04 17:52:37 +01:00

README.md

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 as a database. CouchDB can run as a docker container.

$ 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.yaml.

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

$ pip install -e .
$ shortenit