elia/shortenit
1
0
Fork 0
Code Issues 4 Pull requests 1 Releases Packages Wiki Activity
The personal URL shortener
22 commits 3 branches 0 tags 207 KiB
Python 77.3%
HTML 16.9%
Batchfile 3.2%
Makefile 2.6%
Find a file
Elia el Lazkani 6542ad3a8c chore(): Adds Sphinx to the mix 
* Adds Sphinx to the dependency list
* Generates Sphinx related configuration
* Created Sphinx related docs
2024-11-30 11:50:55 +01:00
config Adding the ability to choose upper or lower case ID generation 2019-10-13 16:42:49 +02:00
docs chore(): Adds Sphinx to the mix 2024-11-30 11:50:55 +01:00
shortenit chore(): Formats the code 2024-11-30 11:07:02 +01:00
.gitignore chore(): Adds Sphinx to the mix 2024-11-30 11:50:55 +01:00
LICENSE Add LICENSE 2019-10-07 22:07:37 +00:00
make.bat chore(): Adds Sphinx to the mix 2024-11-30 11:50:55 +01:00
Makefile chore(): Adds Sphinx to the mix 2024-11-30 11:50:55 +01:00
poetry.lock chore(): Adds Sphinx to the mix 2024-11-30 11:50:55 +01:00
pyproject.toml chore(): Adds Sphinx to the mix 2024-11-30 11:50:55 +01:00
README.md chore(): Updates README 2024-11-30 11:07:24 +01: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 -e COUCHDB_USER=root -e COUCHDB_PASSWORD=root -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