| 1 | # og |
| 2 | |
| 3 | Open Graph tag inspector for any URL. |
| 4 | |
| 5 | ## Install |
| 6 | |
| 7 | **Homebrew:** |
| 8 | |
| 9 | ```bash |
| 10 | brew install stevedylandev/tap/og |
| 11 | ``` |
| 12 | |
| 13 | **Curl install (Linux/macOS):** |
| 14 | |
| 15 | ```bash |
| 16 | curl -fsSL https://raw.githubusercontent.com/stevedylandev/andromeda/main/install.sh | sh -s -- og |
| 17 | ``` |
| 18 | |
| 19 | **PowerShell (Windows):** |
| 20 | |
| 21 | ```powershell |
| 22 | & ([scriptblock]::Create((irm https://raw.githubusercontent.com/stevedylandev/andromeda/main/install.ps1))) og |
| 23 | ``` |
| 24 | |
| 25 | **Prebuilt binary:** Grab the right archive from the [releases page](https://github.com/stevedylandev/andromeda/releases?q=og%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/og |
| 32 | go build . |
| 33 | ``` |
| 34 | |
| 35 | ## Quickstart |
| 36 | |
| 37 | ```bash |
| 38 | cp .env.example .env |
| 39 | go run . |
| 40 | ``` |
| 41 | |
| 42 | Then open `http://localhost:3000`. |
| 43 | |
| 44 | ### Environment Variables |
| 45 | |
| 46 | | Variable | Default | Description | |
| 47 | |---|---|---| |
| 48 | | `HOST` | `0.0.0.0` | Bind host | |
| 49 | | `PORT` | `3000` | Server port | |
| 50 | |
| 51 | ## Routes |
| 52 | |
| 53 | - `GET /` — search form |
| 54 | - `POST /check` — inspect a URL (form field: `url`) |
| 55 | - `GET /static/*` — embedded favicon, styles, etc. |
| 56 | - `GET /assets/darkmatter.css` + `/assets/fonts/*` — served by `pkg/darkmatter` |
| 57 | |
| 58 | ## Build |
| 59 | |
| 60 | ```bash |
| 61 | go build . |
| 62 | ``` |
| 63 | |
| 64 | The binary embeds all templates and static assets. |