🚀 Quick Start

Get OpenGrammar up and running in 5 minutes!

⚡ 5-Minute Setup

Step 1: Get Your API Key (Optional but Recommended)

For the best grammar checking experience, you'll need an API key. We recommend Groq for its free tier:

Visit Groq Console
Sign up / Log in
Go to API Keys → Create API Key
Copy your key (starts with gsk_)

Free Tier: 100 requests/day - enough for most users!

Step 2: Build the Extension

# Clone the repository
git clone https://github.com/swadhinbiswas/opengrammar.git
cd opengrammar/opengrammar/extension

# Install dependencies
bun install

# Build the extension
bun run build

Step 3: Load in Your Browser

Chrome / Brave / Edge

Open chrome://extensions/ (or brave://extensions/ / edge://extensions/)
Enable Developer mode (toggle in top-right)
Click Load unpacked
Select the opengrammar/extension/dist folder
✅ Extension loaded! You'll see the OpenGrammar icon

Firefox

Open about:debugging#/runtime/this-firefox
Click Load Temporary Add-on
Navigate to opengrammar/extension/dist
Select manifest.json
✅ Extension loaded!

Step 4: Configure

Click the OpenGrammar icon in your toolbar
Click Settings (gear icon)
Enter your API key (from Step 1)
Select Provider: Groq
Select Model: llama-3.1-70b-versatile
Backend URL: http://localhost:8787 (for local testing)

Step 5: Start Writing!

Open any text box (Gmail, Google Docs, Notion, etc.)
Type something with a grammar error: me and him went to store
You'll see a red underline under the error
Click it to see the suggestion: he and I went to store
Click Apply to fix it!

🎯 What's Next?

I want to...	Do this...
Deploy to production	Read Backend Deployment
Use local AI (offline)	Read Ollama Setup
Rewrite text in different tones	Read Tone Rewriting
See all features	Read Using OpenGrammar

🛠️ Quick Commands

Start Local Backend

cd opengrammar/opengrammar/backend
bun install
bun run dev
# Runs on http://localhost:8787

Build Extension

cd opengrammar/opengrammar/extension
bun run build

Test Backend

curl http://localhost:8787/health

❓ Need Help?

Something not working? Check Troubleshooting
Have questions? Visit GitHub Discussions
Found a bug? Open GitHub Issues

Congratulations! You're ready to write better with OpenGrammar! ✨