chore: update readme
This commit is contained in:
36
README.md
36
README.md
@@ -1 +1,37 @@
|
|||||||
# pihka.al
|
# pihka.al
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|||||||
BIN
docs/demo.gif
Normal file
BIN
docs/demo.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 388 KiB |
Reference in New Issue
Block a user