elia/shortenit
1
0
Fork 0
Code Issues 7 Pull requests 1 Releases Packages Wiki Activity
The personal URL shortener
41 commits 4 branches 0 tags 1.5 MiB
Python 43.8%
TypeScript 29.6%
CSS 20.2%
HTML 4.8%
Dockerfile 1.3%
Other 0.3%
Find a file
Elia el Lazkani 1887be54e5 chore(#17): Adds Docker packaging to the project
2024-12-27 09:58:15 +01:00
config chore(#17): Adds Docker packaging to the project 2024-12-27 09:58:15 +01:00
docs chore(): Cleans up the docs a bit 2024-12-25 21:27:55 +01:00
frontend fix(): Fixes the packaging, should work as expected when installed 2024-12-25 21:34:55 +01:00
scripts enh(#8): Refactoring code 2024-12-24 01:40:50 +01:00
shortenit chore(#17): Adds Docker packaging to the project 2024-12-27 09:58:15 +01:00
.gitignore fix(): Fixes the packaging, should work as expected when installed 2024-12-25 21:34:55 +01:00
Dockerfile chore(#17): Adds Docker packaging to the project 2024-12-27 09:58:15 +01:00
LICENSE Add LICENSE 2019-10-07 22:07:37 +00:00
poetry.lock feat(#20): Adds Enable UI feature to disable serving the UI 2024-12-25 21:56:16 +01:00
pyproject.toml fix(): Fixes the packaging, should work as expected when installed 2024-12-25 21:34:55 +01:00
README.md chore(#8): Adds scripts to install, build and run the project 2024-12-24 01:40:15 +01:00

README.md

Shortenit

Shortenit is a tool to shorten urls.

NOTE: This is a very early draft project. Contributions are welcome.

Install

To install shortenit and all of its dependencies for development, run the following script.

$ scripts/install.sh

Running

To run shortenit for development, edit the configuration file found in config/config.yaml then run the following script.

$ scripts/run.sh