Skip to content

Commit 4189884

Browse files
chore: update README.md and src/app/words/page.tsx
1 parent f0bdcc7 commit 4189884

File tree

2 files changed

+33
-3
lines changed

2 files changed

+33
-3
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,3 +167,35 @@ http://localhost:3000
167167
## 📜 License
168168

169169
MIT License
170+
171+
# ProWords Project
172+
173+
## Getting Started
174+
175+
### Environment Setup
176+
177+
1. Create a `.env.local` file in the project root:
178+
179+
```bash
180+
# Create .env.local file
181+
touch .env.local
182+
```
183+
184+
2. Add the following required environment variables to the `.env.local` file:
185+
186+
```bash
187+
NEXT_PUBLIC_BASE_URL=your_api_base_url
188+
NEXT_PUBLIC_OPENAI_API_KEY=your_api_key
189+
```
190+
191+
Example:
192+
```bash
193+
NEXT_PUBLIC_BASE_URL=https://api.rdsec.trendmicro.com/prod/aiendpoint/v1/
194+
NEXT_PUBLIC_OPENAI_API_KEY=your_jwt_token_here
195+
```
196+
197+
These environment variables are essential for the application to connect to the required APIs.
198+
199+
### Running the Project
200+
201+
[Additional setup instructions will go here]

src/app/words/page.tsx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,14 @@ import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@
88
import { Badge } from "@/components/ui/badge"
99
import {
1010
RefreshCcw, Volume2, ChevronLeft, ChevronRight,
11-
BookOpen, BookText, CircleDashed, Bot, Sparkles,
11+
BookOpen, BookText, Bot, Sparkles,
1212
GraduationCap, Home, ArrowRight, Moon, Sun
1313
} from "lucide-react"
1414
import { Loader2 } from "lucide-react"
1515
import { Identity, Word, DictionaryEntry } from "@/app/types/types"
1616
import { getWordsFromChapter } from '@/app/utils/wordUtils'
1717
import { Progress } from "@/components/ui/progress"
18-
import { Tabs, TabsContent, TabsList, TabsTrigger } from "@/components/ui/tabs"
1918
import { ScrollArea } from "@/components/ui/scroll-area"
20-
import Link from "next/link"
2119
import { ChapterComplete } from "@/components/ChapterComplete"
2220

2321
export default function WordsPage() {

0 commit comments

Comments
 (0)