shortenit/README.md
Elia el Lazkani 6800c90936 chore(#5): Migration to SQLAlchemy
* Introduces models to map objects in the database
* Refactoring and cleanup of old code
* Updates configuration file
* Updates README.md
* Updates .gitignore
2024-12-18 01:38:31 +01:00

14 lines
312 B
Markdown

# Shortenit
Shortenit is a tool to shorten urls.
**NOTE**: This is a very early draft project. Contributions are welcome.
## Running
To run `shortenit`, edit the configuration file found in [config/config.yaml](config/config.yaml) then run the following commands.
```text
$ pip install -e .
$ shortenit
```