Fix issues and add linting
This commit is contained in:
19
README.md
19
README.md
@@ -7,7 +7,7 @@ An LLM-powered website editing framework. Edit your site via SMS, a web API, or
|
||||
```
|
||||
┌─────────────────────────────────────────────────┐
|
||||
│ Channels │
|
||||
│ SMS (Telnyx) │ POST /api/edit │ /editor │
|
||||
│ SMS (Vonage) │ POST /api/edit │ /editor │
|
||||
└───────┬─────────┴────────┬─────────┴─────┬──────┘
|
||||
│ │ │
|
||||
▼ ▼ ▼
|
||||
@@ -46,6 +46,7 @@ An LLM-powered website editing framework. Edit your site via SMS, a web API, or
|
||||
### Prerequisites
|
||||
- Node.js 22+
|
||||
- npm
|
||||
- A Vonage API account with a Messages API-enabled application
|
||||
|
||||
### Local Development
|
||||
|
||||
@@ -69,9 +70,23 @@ Copy `.env.example` to `.env` and set at minimum:
|
||||
|
||||
- `API_EDIT_SECRET` — shared secret for API auth and editor login
|
||||
- `OLLAMA_API_KEY` — required for LLM-powered edits
|
||||
- `VONAGE_API_KEY` — your Vonage API key (from Dashboard)
|
||||
- `VONAGE_API_SECRET` — your Vonage API secret (from Dashboard)
|
||||
- `VONAGE_APPLICATION_ID` — your Vonage application ID
|
||||
- `VONAGE_PRIVATE_KEY_PATH` — path to the `private.key` file generated when creating the Vonage application
|
||||
- `VONAGE_API_SIGNATURE_SECRET` — webhook signature secret (from Dashboard → API Settings)
|
||||
|
||||
See `.env.example` for all options.
|
||||
|
||||
### Vonage Setup
|
||||
|
||||
1. Create a Vonage application in the Dashboard with Messages capability enabled.
|
||||
2. Set the inbound message webhook URL to `https://dynamicsites.kadil.dev/webhooks/inbound` (POST).
|
||||
3. Set the status webhook URL to `https://dynamicsites.kadil.dev/webhooks/status` (POST).
|
||||
4. Under API Settings, ensure Messages API is set as the default for SMS.
|
||||
5. Copy the generated `private.key` to the project root.
|
||||
6. Note your signature secret from Dashboard → API Settings for webhook verification.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
@@ -105,7 +120,7 @@ docker compose up -d
|
||||
│ ├── queue/ # FIFO queue + job processor
|
||||
│ ├── routes/ # API edit, SMS webhook, health
|
||||
│ ├── llm/ # Ollama client with retry/validation
|
||||
│ ├── sms/ # Telnyx parse, reply, templates
|
||||
│ ├── sms/ # Vonage parse, reply, templates
|
||||
│ └── io/ # Filesystem writer (atomic, with backup)
|
||||
├── src/ # Astro SSR site
|
||||
│ ├── pages/
|
||||
|
||||
Reference in New Issue
Block a user