mirror of
https://github.com/geoffsee/open-gsio.git
synced 2025-09-08 22:56:46 +00:00
run format
This commit is contained in:

committed by
Geoff Seemueller

parent
02c3253343
commit
f76301d620
@@ -1,7 +1,9 @@
|
||||
# open-gsio
|
||||
|
||||
[](https://github.com/geoffsee/open-gsio/actions/workflows/test.yml)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
</br>
|
||||
|
||||
<p align="center">
|
||||
<img src="https://github.com/user-attachments/assets/620d2517-e7be-4bb0-b2b7-3aa0cba37ef0" width="250" />
|
||||
</p>
|
||||
@@ -15,59 +17,63 @@
|
||||
- [Installation](#installation)
|
||||
- [Deployment](#deployment)
|
||||
- [Local Inference](#local-inference)
|
||||
- [mlx-omni-server (default)](#mlx-omni-server)
|
||||
- [Adding models](#adding-models-for-local-inference-apple-silicon)
|
||||
- [Ollama](#ollama)
|
||||
- [Adding models](#adding-models-for-local-inference-ollama)
|
||||
- [mlx-omni-server (default)](#mlx-omni-server)
|
||||
- [Adding models](#adding-models-for-local-inference-apple-silicon)
|
||||
- [Ollama](#ollama)
|
||||
- [Adding models](#adding-models-for-local-inference-ollama)
|
||||
- [Testing](#testing)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [History](#history)
|
||||
- [License](#license)
|
||||
|
||||
## Stack
|
||||
* [TypeScript](https://www.typescriptlang.org/)
|
||||
* [Vike](https://vike.dev/)
|
||||
* [React](https://react.dev/)
|
||||
* [Cloudflare Workers](https://developers.cloudflare.com/workers/)
|
||||
* [itty‑router](https://github.com/kwhitley/itty-router)
|
||||
* [MobX‑State‑Tree](https://mobx-state-tree.js.org/)
|
||||
* [OpenAI SDK](https://github.com/openai/openai-node)
|
||||
* [Vitest](https://vitest.dev/)
|
||||
|
||||
- [TypeScript](https://www.typescriptlang.org/)
|
||||
- [Vike](https://vike.dev/)
|
||||
- [React](https://react.dev/)
|
||||
- [Cloudflare Workers](https://developers.cloudflare.com/workers/)
|
||||
- [itty‑router](https://github.com/kwhitley/itty-router)
|
||||
- [MobX‑State‑Tree](https://mobx-state-tree.js.org/)
|
||||
- [OpenAI SDK](https://github.com/openai/openai-node)
|
||||
- [Vitest](https://vitest.dev/)
|
||||
|
||||
## Installation
|
||||
|
||||
1. `bun i && bun test`
|
||||
1. [Add your own `GROQ_API_KEY` in .dev.vars](https://console.groq.com/keys)
|
||||
1. [Add your own `GROQ_API_KEY` in .dev.vars](https://console.groq.com/keys)
|
||||
1. In isolated shells, run `bun run server:dev` and `bun run client:dev`
|
||||
|
||||
> Note: it should be possible to use pnpm in place of bun.
|
||||
> Note: it should be possible to use pnpm in place of bun.
|
||||
|
||||
## Deployment
|
||||
1. Setup the KV_STORAGE bindings in `wrangler.jsonc`
|
||||
1. [Add another `GROQ_API_KEY` in secrets.json](https://console.groq.com/keys)
|
||||
|
||||
1. Setup the KV_STORAGE bindings in `wrangler.jsonc`
|
||||
1. [Add another `GROQ_API_KEY` in secrets.json](https://console.groq.com/keys)
|
||||
1. Run `bun run deploy && bun run deploy:secrets && bun run deploy`
|
||||
|
||||
> Note: Subsequent deployments should omit `bun run deploy:secrets`
|
||||
|
||||
|
||||
## Local Inference
|
||||
|
||||
> Local inference is achieved by overriding the `OPENAI_API_KEY` and `OPENAI_API_ENDPOINT` environment variables. See below.
|
||||
|
||||
### mlx-omni-server
|
||||
|
||||
(default) (Apple Silicon Only) - Use Ollama for other platforms.
|
||||
~~~bash
|
||||
|
||||
```bash
|
||||
# (prereq) install mlx-omni-server
|
||||
brew tap seemueller-io/tap
|
||||
brew install seemueller-io/tap/mlx-omni-server
|
||||
brew tap seemueller-io/tap
|
||||
brew install seemueller-io/tap/mlx-omni-server
|
||||
|
||||
bun run openai:local mlx-omni-server # Start mlx-omni-server
|
||||
bun run openai:local:enable # Configure connection
|
||||
bun run server:dev # Restart server
|
||||
~~~
|
||||
```
|
||||
|
||||
#### Adding models for local inference (Apple Silicon)
|
||||
|
||||
~~~bash
|
||||
```bash
|
||||
# ensure mlx-omni-server is running
|
||||
|
||||
# See https://huggingface.co/mlx-community for available models
|
||||
@@ -79,22 +85,23 @@ curl http://localhost:10240/v1/chat/completions \
|
||||
\"model\": \"$MODEL_TO_ADD\",
|
||||
\"messages\": [{\"role\": \"user\", \"content\": \"Hello\"}]
|
||||
}"
|
||||
~~~
|
||||
```
|
||||
|
||||
### Ollama
|
||||
~~~bash
|
||||
|
||||
```bash
|
||||
bun run openai:local ollama # Start ollama server
|
||||
bun run openai:local:enable # Configure connection
|
||||
bun run server:dev # Restart server
|
||||
~~~
|
||||
```
|
||||
|
||||
#### Adding models for local inference (ollama)
|
||||
|
||||
~~~bash
|
||||
```bash
|
||||
# See https://ollama.com/library for available models
|
||||
MODEL_TO_ADD=gemma3
|
||||
MODEL_TO_ADD=gemma3
|
||||
docker exec -it ollama ollama run ${MODEL_TO_ADD}
|
||||
~~~
|
||||
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
@@ -102,20 +109,21 @@ Tests are located in `__tests__` directories next to the code they test. Testing
|
||||
|
||||
> `bun run test` will run all tests
|
||||
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
1. `bun run clean`
|
||||
1. `bun i`
|
||||
1. `bun server:dev`
|
||||
1. `bun client:dev`
|
||||
1. Submit an issue
|
||||
1. `bun server:dev`
|
||||
1. `bun client:dev`
|
||||
1. Submit an issue
|
||||
|
||||
History
|
||||
---
|
||||
A high-level overview for the development history of the parent repository, [geoff-seemueller-io](https://geoff.seemueller.io), is provided in [LEGACY.md](../../LEGACY.md).
|
||||
## History
|
||||
|
||||
A high-level overview for the development history of the parent repository, [geoff-seemueller-io](https://geoff.seemueller.io), is provided in [LEGACY.md](../../LEGACY.md).
|
||||
|
||||
## License
|
||||
~~~text
|
||||
|
||||
```text
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 Geoff Seemueller
|
||||
@@ -137,5 +145,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
~~~
|
||||
|
||||
```
|
||||
|
@@ -8,11 +8,6 @@
|
||||
"outDir": "dist",
|
||||
"rootDir": "."
|
||||
},
|
||||
"include": [
|
||||
"*.ts"
|
||||
],
|
||||
"exclude": [
|
||||
"node_modules",
|
||||
"*.test.ts"
|
||||
]
|
||||
"include": ["*.ts"],
|
||||
"exclude": ["node_modules", "*.test.ts"]
|
||||
}
|
||||
|
Reference in New Issue
Block a user