swadhin / opengrammar public

swadhinbiswas

[email protected]
2026-03-14 19:11:29 +0600 committed NaN years ago
74aebf9
commit 74aebf9
1 file changed
+111 -0
Showing 1 changed file+111-0
docs/01-quick-start.md
▼docs/01-quick-start.md
+111-0
@@ -0,0 +1,111 @@
1
+# 🚀 Quick Start
2
+
3
+Get OpenGrammar up and running in 5 minutes!
4
+
5
+---
6
+
7
+## ⚡ 5-Minute Setup
8
+
9
+### Step 1: Get Your API Key (Optional but Recommended)
10
+
11
+For the best grammar checking experience, you'll need an API key. We recommend **Groq** for its free tier:
12
+
13
+1. Visit [Groq Console](https://console.groq.com)
14
+2. Sign up / Log in
15
+3. Go to **API Keys** → **Create API Key**
16
+4. Copy your key (starts with `gsk_`)
17
+
18
+**Free Tier:** 100 requests/day - enough for most users!
19
+
20
+### Step 2: Build the Extension
21
+
22
+```bash
23
+# Clone the repository
24
+git clone https://github.com/swadhinbiswas/opengrammar.git
25
+cd opengrammar/opengrammar/extension
26
+
27
+# Install dependencies
28
+bun install
29
+
30
+# Build the extension
31
+bun run build
32
+```
33
+
34
+### Step 3: Load in Your Browser
35
+
36
+#### Chrome / Brave / Edge
37
+1. Open `chrome://extensions/` (or `brave://extensions/` / `edge://extensions/`)
38
+2. Enable **Developer mode** (toggle in top-right)
39
+3. Click **Load unpacked**
40
+4. Select the `opengrammar/extension/dist` folder
41
+5. ✅ Extension loaded! You'll see the OpenGrammar icon
42
+
43
+#### Firefox
44
+1. Open `about:debugging#/runtime/this-firefox`
45
+2. Click **Load Temporary Add-on**
46
+3. Navigate to `opengrammar/extension/dist`
47
+4. Select `manifest.json`
48
+5. ✅ Extension loaded!
49
+
50
+### Step 4: Configure
51
+
52
+1. Click the OpenGrammar icon in your toolbar
53
+2. Click **Settings** (gear icon)
54
+3. Enter your API key (from Step 1)
55
+4. Select Provider: **Groq**
56
+5. Select Model: **llama-3.1-70b-versatile**
57
+6. Backend URL: `http://localhost:8787` (for local testing)
58
+
59
+### Step 5: Start Writing!
60
+
61
+1. Open any text box (Gmail, Google Docs, Notion, etc.)
62
+2. Type something with a grammar error: `me and him went to store`
63
+3. You'll see a **red underline** under the error
64
+4. Click it to see the suggestion: `he and I went to store`
65
+5. Click **Apply** to fix it!
66
+
67
+---
68
+
69
+## 🎯 What's Next?
70
+
71
+| I want to... | Do this... |
72
+|--------------|------------|
73
+| Deploy to production | Read [Backend Deployment](05-backend-deployment.md) |
74
+| Use local AI (offline) | Read [Ollama Setup](07-ai-providers.md#ollama-local) |
75
+| Rewrite text in different tones | Read [Tone Rewriting](10-tone-rewriting.md) |
76
+| See all features | Read [Using OpenGrammar](09-using-opengrammar.md) |
77
+
78
+---
79
+
80
+## 🛠️ Quick Commands
81
+
82
+### Start Local Backend
83
+```bash
84
+cd opengrammar/opengrammar/backend
85
+bun install
86
+bun run dev
87
+# Runs on http://localhost:8787
88
+```
89
+
90
+### Build Extension
91
+```bash
92
+cd opengrammar/opengrammar/extension
93
+bun run build
94
+```
95
+
96
+### Test Backend
97
+```bash
98
+curl http://localhost:8787/health
99
+```
100
+
101
+---
102
+
103
+## ❓ Need Help?
104
+
105
+- **Something not working?** Check [Troubleshooting](18-troubleshooting.md)
106
+- **Have questions?** Visit [GitHub Discussions](https://github.com/swadhinbiswas/opengrammar/discussions)
107
+- **Found a bug?** Open [GitHub Issues](https://github.com/swadhinbiswas/opengrammar/issues)
108
+
109
+---
110
+
111
+**Congratulations! You're ready to write better with OpenGrammar! ✨**
0
112