shortn
HTML/CSS/JS Framework Free ✅ • Lightweight ✅ • Functional ✅ • No plaintext passwords ✅
Simple link shortener built with flask.
## Installation
```bash
git clone https://git.confest.im/boyan_k/shortn
pip install -r requirements.txt
```
## Usage (no docker)
```bash
python manage_users.py init # to create the database
python manage_users.py add # to add a user
>>> Name: admin
>>> Password: *****
>>> Again: *****
python manage_users.py list # to list users
python manage_users.py remove --username # to remove a user
# Finally, running the app
python app.py
```
## Usage (docker)
This will init the database and create a user with the username `admin` and password `admin`.
```bash
docker compose up -d # remove -d for foreground
```
### Users
```bash
sudo docker exec -it shortn python src/manage_users.py add
sudo docker exec -it shortn python src/manage_users.py list
sudo docker exec -it shortn python src/manage_users.py remove --username
```
> [!NOTE] The database is **ephemeral** and will be lost when the container is removed. That is intentional.
## TODOs
- [x] basic UI (to add links)
- [x] basic auth for UI
- [x] sqlite3 to store links
- [x] responsive? (sorta)
- [x] dockerize