diff --git a/README.md b/README.md index 020348f..fdcd493 100644 --- a/README.md +++ b/README.md @@ -1 +1,37 @@ # pihka.al + +![demo](docs/demo.gif) + +Personal dashboard for managing my [pihka.al](https://pihka.al) domain. I'm building it for my own use, it's not designed as a generic tool and not meant to be reused as-is. + +## What it does + +- Manage short URLs served from [pihka.al](https://pihka.al) + +## Next features + +- **API**: Create an API token that can be used to manage short URLs from anywere +- **File management**: Upload and manage files directly in the dasboard +- **Text service**: Pastebin-like service, including burner messages + +## Stack + +- [Nuxt 4](https://nuxt.com) + [Nuxt UI](https://ui.nuxt.com) +- [SQLite](https://sqlite.org) via [Drizzle ORM](https://orm.drizzle.team) + +## Running locally + +```sh +pnpm install +pnpm dev +``` + +``` +# .env.example +DATABASE_URL=sqlite.db +ADMIN_USERNAME=admin +ADMIN_PASSWORD=strong_password +REDIRECT_DOMAIN=pihka.al + +NUXT_SESSION_PASSWORD=strong_password +``` diff --git a/docs/demo.gif b/docs/demo.gif new file mode 100644 index 0000000..fa77be3 Binary files /dev/null and b/docs/demo.gif differ