| 1 | # bookmarks |
| 2 | |
| 3 | Personal link saver organized by category. |
| 4 | |
| 5 | ## Install |
| 6 | |
| 7 | **Homebrew:** |
| 8 | |
| 9 | ```bash |
| 10 | brew install stevedylandev/tap/bookmarks |
| 11 | ``` |
| 12 | |
| 13 | **Curl install (Linux/macOS):** |
| 14 | |
| 15 | ```bash |
| 16 | curl -fsSL https://raw.githubusercontent.com/stevedylandev/andromeda/main/install.sh | sh -s -- bookmarks |
| 17 | ``` |
| 18 | |
| 19 | **PowerShell (Windows):** |
| 20 | |
| 21 | ```powershell |
| 22 | & ([scriptblock]::Create((irm https://raw.githubusercontent.com/stevedylandev/andromeda/main/install.ps1))) bookmarks |
| 23 | ``` |
| 24 | |
| 25 | **Prebuilt binary:** Grab the right archive from the [releases page](https://github.com/stevedylandev/andromeda/releases?q=bookmarks%2F) and drop the binary somewhere on your `$PATH`. |
| 26 | |
| 27 | **From source:** |
| 28 | |
| 29 | ```bash |
| 30 | git clone https://github.com/stevedylandev/andromeda |
| 31 | cd andromeda/apps/bookmarks |
| 32 | go build . |
| 33 | ``` |
| 34 | |
| 35 | ## Quickstart |
| 36 | |
| 37 | ```bash |
| 38 | cp .env.example .env |
| 39 | go run . |
| 40 | ``` |
| 41 | |
| 42 | ### Environment Variables |
| 43 | |
| 44 | | Variable | Default | Description | |
| 45 | |---|---|---| |
| 46 | | `BOOKMARKS_PASSWORD` | — | Admin panel password | |
| 47 | | `BOOKMARKS_API_KEY` | — | API key for `POST /api/links` | |
| 48 | | `BOOKMARKS_DB_PATH` | `bookmarks.sqlite` | SQLite path | |
| 49 | | `HOST` | `127.0.0.1` | Bind host | |
| 50 | | `PORT` | `3000` | Server port | |
| 51 | | `COOKIE_SECURE` | `false` | Mark session cookie Secure | |
| 52 | |
| 53 | ## Routes |
| 54 | |
| 55 | Public: `GET /`, `GET /api/categories`, `GET /api/links`. Auth: `GET/POST /login`, |
| 56 | `GET /logout`, `/admin`, `/admin/*`. API-key: `POST /api/links`. |