Elia el Lazkani c7c546f371 chore(): Updates README

CouchDB changed since the last time of development, updating the
README.md to match the changes.

2024-11-30 11:07:24 +01:00

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