opengrammar-server 2.0.615350

package/README.npm.md

@@ -0,0 +1,95 @@
+# opengrammar-server
+
+> Privacy-first, open-source grammar intelligence server — run it on **any device**.
+
+[![npm version](https://img.shields.io/npm/v/opengrammar-server)](https://www.npmjs.com/package/opengrammar-server)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Turn **any device** into a local OpenGrammar API server — your old Android phone via Termux, a Raspberry Pi, an old laptop, or any VPS.
+
+## Quick Start
+
+```bash
+# Run instantly (no install needed)
+npx opengrammar-server
+
+# Or install globally
+npm install -g opengrammar-server
+opengrammar-server
+```
+
+That's it. Your server is live at `http://localhost:8787` 🎉
+
+## Options
+
+```bash
+opengrammar-server --port 3000          # Custom port
+opengrammar-server --host 127.0.0.1    # Localhost only (more secure)
+opengrammar-server --help               # Show all options
+opengrammar-server --version            # Show version
+```
+
+## API Endpoints
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| `GET`  | `/`            | Status dashboard |
+| `GET`  | `/health`      | Health check |
+| `POST` | `/analyze`     | Grammar analysis |
+| `POST` | `/autocomplete`| Text completion |
+| `GET`  | `/providers`   | List AI providers |
+
+### Example
+
+```bash
+# Check health
+curl http://localhost:8787/health
+
+# Analyze text
+curl -X POST http://localhost:8787/analyze \
+  -H "Content-Type: application/json" \
+  -d '{"text": "Me and him went to store yesterday"}'
+```
+
+## 🤖 Run on Android (Termux)
+
+Turn your old Android phone into a grammar server!
+
+```bash
+# 1. Install Termux from F-Droid (not Play Store)
+# 2. Inside Termux:
+pkg update && pkg install nodejs
+npx opengrammar-server --port 8787
+```
+
+Your phone is now a grammar server accessible on your local network at `http://<phone-ip>:8787`.
+
+## 🍓 Run on Raspberry Pi
+
+```bash
+curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
+sudo apt-get install -y nodejs
+npx opengrammar-server
+```
+
+## 🐳 Docker
+
+```bash
+docker run -p 8787:8787 swadhinbiswas/opengrammar-backend:latest
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `PORT` | Server port (default: `8787`) |
+| `HOST` | Bind host (default: `0.0.0.0`) |
+| `GROQ_API_KEY` | Groq API key for AI features (optional) |
+| `OPENAI_API_KEY` | OpenAI API key (optional) |
+
+## Links
+
+- 🌐 **Website:** https://opengrammer.eu.cc
+- 📦 **GitHub:** https://github.com/swadhinbiswas/opengrammar
+- 🐛 **Issues:** https://github.com/swadhinbiswas/opengrammar/issues
+- ☁️ **Hosted API:** https://opengrammar-backend-production.thelabrats-dev.workers.dev

package/bin/opengrammar-server.js

@@ -0,0 +1,111 @@
+#!/usr/bin/env node
+
+/**
+ * OpenGrammar Server — CLI Entry Point
+ * 
+ * Usage:
+ *   npx opengrammar-server
+ *   npx opengrammar-server --port 3000
+ *   npx opengrammar-server --help
+ */
+
+import { createRequire } from 'module';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+import { parseArgs } from 'util';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+// Parse CLI args
+let args;
+try {
+  const parsed = parseArgs({
+    args: process.argv.slice(2),
+    options: {
+      port: { type: 'string', short: 'p', default: '8787' },
+      host: { type: 'string', short: 'h', default: '0.0.0.0' },
+      help: { type: 'boolean', short: '?', default: false },
+      version: { type: 'boolean', short: 'v', default: false },
+    },
+    strict: false,
+  });
+  args = parsed.values;
+} catch {
+  args = { port: '8787', host: '0.0.0.0', help: false, version: false };
+}
+
+if (args.version) {
+  const pkg = createRequire(import.meta.url)(join(__dirname, '../package.json'));
+  console.log(`opengrammar-server v${pkg.version}`);
+  process.exit(0);
+}
+
+if (args.help) {
+  console.log(`
+  ┌─────────────────────────────────────────────────────┐
+  │            OpenGrammar Server  v2.0.0               │
+  │   Privacy-first grammar intelligence on your device  │
+  └─────────────────────────────────────────────────────┘
+
+  Usage:
+    npx opengrammar-server [options]
+
+  Options:
+    -p, --port <port>   Port to listen on (default: 8787)
+    -h, --host <host>   Host to bind to  (default: 0.0.0.0)
+    -v, --version       Show version
+    -?, --help          Show this help
+
+  Examples:
+    npx opengrammar-server
+    npx opengrammar-server --port 3000
+    npx opengrammar-server --port 8080 --host 127.0.0.1
+
+  API Endpoints:
+    GET  /           Status dashboard
+    GET  /health     Health check
+    POST /analyze    Grammar analysis
+    POST /autocomplete  Text completion
+    GET  /providers  List AI providers
+
+  Docs: https://opengrammer.eu.cc
+  `);
+  process.exit(0);
+}
+
+// Set port before importing server
+const port = parseInt(args.port, 10) || 8787;
+const host = args.host || '0.0.0.0';
+
+process.env.PORT = String(port);
+process.env.HOST = host;
+
+// Banner
+console.log(`
+  ┌─────────────────────────────────────────────────────┐
+  │            OpenGrammar Server  v2.0.0               │
+  │   Privacy-first grammar intelligence on your device │
+  └─────────────────────────────────────────────────────┘
+`);
+console.log(`  Starting server on http://${host}:${port}`);
+console.log(`  Press Ctrl+C to stop\n`);
+
+// Start the Hono server
+try {
+  await import(join(__dirname, '../dist/server.js'));
+} catch {
+  // Fallback: use tsx at runtime if dist/ doesn't exist (dev mode / npx)
+  const { spawn } = await import('child_process');
+  const child = spawn(
+    'node',
+    ['--import', 'tsx/esm', join(__dirname, '../server-node.ts')],
+    {
+      stdio: 'inherit',
+      env: { ...process.env, PORT: String(port), HOST: host },
+    }
+  );
+  child.on('error', () => {
+    console.error('\n  ❌ Failed to start. Try: npm install -g tsx\n');
+    process.exit(1);
+  });
+}