Skip to content

Test A: add Quick Start (local dev) section #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
weselben wants to merge 1 commit into from
Closed

Test A: add Quick Start (local dev) section #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,26 @@ curl http://localhost:8080/v1/responses \
}'
```

## Quick Start (local dev)

Spin up a throwaway local dev preview with Docker (preview port range 64900-65000, preview host 116.202.192.143):

```bash
docker run --rm -d \
--name gomodel-dev \
-p 64900:8080 \
-e OPENAI_API_KEY="your-openai-key" \
enterpilot/gomodel
```

Then open the dashboard at `http://116.202.192.143:64900/admin/dashboard` (or `http://localhost:64900/admin/dashboard` when running locally).

Stop the preview with:

```bash
docker stop gomodel-dev
```

## Using GoModel with official SDKs

GoModel exposes an OpenAI-compatible API at `/v1` and an Anthropic-compatible
Expand Down