feat: add Docker support with Dockerfile, compose, CI, and oneliner install
- Multi-stage Dockerfile (node build + nginx:alpine serve) - nginx.conf with SPA fallback, gzip, asset caching - docker-compose.yml for easy deployment - GitHub Actions workflow to build & push to ghcr.io on every push - .dockerignore to keep image lean - Updated README with Docker-first quick start and badge
This commit is contained in:
30
README.md
30
README.md
@@ -3,6 +3,7 @@
|
||||
[](https://github.com/MarlBurroW/pinchchat/actions/workflows/ci.yml)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://nodejs.org/)
|
||||
[](https://github.com/MarlBurroW/pinchchat/pkgs/container/pinchchat)
|
||||
|
||||
**A sleek, dark-themed webchat UI for [OpenClaw](https://github.com/openclaw/openclaw) — monitor sessions, stream responses, and inspect tool calls in real-time.**
|
||||
|
||||
@@ -22,18 +23,31 @@
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Prerequisites
|
||||
### Docker (recommended)
|
||||
|
||||
- **Node.js 18+**
|
||||
- **OpenClaw gateway** running and accessible
|
||||
```bash
|
||||
docker run -p 3000:80 ghcr.io/marlburrow/pinchchat:latest
|
||||
```
|
||||
|
||||
### Installation
|
||||
Open `http://localhost:3000` and enter your OpenClaw gateway URL + token on the login screen.
|
||||
|
||||
Or use Docker Compose:
|
||||
|
||||
```bash
|
||||
curl -O https://raw.githubusercontent.com/MarlBurroW/pinchchat/main/docker-compose.yml
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### From source
|
||||
|
||||
**Prerequisites:** Node.js 18+, an OpenClaw gateway running and accessible.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/MarlBurroW/pinchchat.git
|
||||
cd pinchchat
|
||||
npm install
|
||||
cp .env.example .env
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Optionally edit `.env` to pre-fill the gateway URL:
|
||||
@@ -43,13 +57,7 @@ VITE_GATEWAY_WS_URL=ws://localhost:18789
|
||||
VITE_LOCALE=en # or "fr" for French UI
|
||||
```
|
||||
|
||||
Start the dev server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
### Production
|
||||
### Production build
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
|
||||
Reference in New Issue
Block a user