-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathHOW_TO_RUN.txt
More file actions
231 lines (162 loc) · 13.2 KB
/
Copy pathHOW_TO_RUN.txt
File metadata and controls
231 lines (162 loc) · 13.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
╔════════════════════════════════════════════════════════════════════════════╗
║ ║
║ HOW TO RUN - DIMENSIONALITY ASPECT-BASED SENTIMENT ANALYSIS DASHBOARD ║
║ ║
╚════════════════════════════════════════════════════════════════════════════╝
┌────────────────────────────────────────────────────────────────────────────┐
│ STEP 1: INSTALL NODE.JS │
└────────────────────────────────────────────────────────────────────────────┘
1. Visit: https://nodejs.org/
2. Download the LTS version (recommended for most users)
3. Run the installer
4. Follow installation steps (keep all defaults)
5. Restart your computer after installation
To verify installation:
Open Command Prompt/Terminal and type:
node --version
npm --version
You should see version numbers (e.g., v18.17.0 and 9.6.7)
┌────────────────────────────────────────────────────────────────────────────┐
│ STEP 2: INSTALL PROJECT DEPENDENCIES │
└────────────────────────────────────────────────────────────────────────────┘
1. Open Command Prompt (Windows) or Terminal (Mac/Linux)
2. Navigate to the project folder:
For Windows:
cd "c:\Users\durga\OneDrive\hackathon\SENTIMENT ANALYSIS DASHBOARD"
For Mac/Linux:
cd "/path/to/SENTIMENT ANALYSIS DASHBOARD"
3. Install all required packages:
npm install
4. Wait for installation to complete (this may take 2-5 minutes)
┌────────────────────────────────────────────────────────────────────────────┐
│ STEP 3: START THE SERVER │
└────────────────────────────────────────────────────────────────────────────┘
1. In the same Command Prompt/Terminal window, type:
npm start
2. You should see:
"Server running on http://localhost:3000"
"Real-time News Sentiment Analysis Dashboard is ready!"
3. Keep this window open! (The server must keep running)
┌────────────────────────────────────────────────────────────────────────────┐
│ STEP 4: OPEN THE WEBSITE │
└────────────────────────────────────────────────────────────────────────────┘
1. Open your web browser (Chrome, Firefox, Edge, or Safari)
2. Type this in the address bar:
http://localhost:3000
3. Press Enter
4. The dashboard will load!
┌────────────────────────────────────────────────────────────────────────────┐
│ STEP 5: USE THE DASHBOARD │
└────────────────────────────────────────────────────────────────────────────┘
1. Enter a search query (or use the default: "AI OR artificial intelligence")
2. Set the number of articles (5-50, default is 20)
3. Click "Fetch & Analyze"
4. Wait a few seconds for results
5. Explore the results:
✓ Aspect Dimensions (8 different aspects analyzed)
✓ Overall Sentiment Statistics
✓ Interactive Charts and Graphs
✓ Individual Articles with Aspect Tags
╔════════════════════════════════════════════════════════════════════════════╗
║ THE 8 ASPECT DIMENSIONS ANALYZED ║
╚════════════════════════════════════════════════════════════════════════════╝
⭐ QUALITY - Overall quality, excellence, superiority
⚡ PERFORMANCE - Speed, efficiency, responsiveness
💰 PRICE - Cost, value, affordability
🤝 SERVICE - Customer service, support, helpfulness
🔧 FEATURES - Functionality, capabilities, options
🛡️ RELIABILITY - Dependability, stability, trustworthiness
🎨 DESIGN - Aesthetics, look, style
👆 USABILITY - Ease of use, user-friendliness, simplicity
╔════════════════════════════════════════════════════════════════════════════╗
║ COMMON ISSUES & SOLUTIONS ║
╚════════════════════════════════════════════════════════════════════════════╝
❌ "npm is not recognized"
➜ Install Node.js first (Step 1)
➜ Restart your computer
➜ Try again
❌ "Cannot find module"
➜ Run: npm install
➜ Make sure you're in the correct directory
❌ "Port 3000 already in use"
➜ Close other programs using port 3000
➜ Or edit server.js to change the port
❌ Website doesn't load
➜ Make sure server is running
➜ Check for errors in the terminal
➜ Try: http://127.0.0.1:3000
❌ "Failed to fetch news"
➜ Check internet connection
➜ Try a different search query
╔════════════════════════════════════════════════════════════════════════════╗
║ STOPPING THE SERVER ║
╚════════════════════════════════════════════════════════════════════════════╝
When you're done:
1. Go to the terminal where the server is running
2. Press Ctrl+C
3. Type 'Y' if prompted
4. Server will stop
╔════════════════════════════════════════════════════════════════════════════╗
║ RESTARTING LATER ║
╚════════════════════════════════════════════════════════════════════════════╝
To run the dashboard again:
1. Open Command Prompt/Terminal
2. cd to the project directory
3. Run: npm start
4. Open browser to: http://localhost:3000
╔════════════════════════════════════════════════════════════════════════════╗
║ FEATURES OVERVIEW ║
╚════════════════════════════════════════════════════════════════════════════╝
✓ Multi-dimensional aspect-based sentiment analysis
✓ 8 different aspect categories analyzed
✓ Real-time news fetching
✓ Interactive visualizations and charts
✓ Aspect distribution analysis
✓ Sentiment breakdown per aspect
✓ Historical trend tracking
✓ Auto-update feature (every 60 seconds)
✓ Keyword extraction and frequency analysis
✓ Individual article aspect tagging
✓ Predictive trend forecasting
╔════════════════════════════════════════════════════════════════════════════╗
║ EXAMPLE SEARCH QUERIES ║
╚════════════════════════════════════════════════════════════════════════════╝
Try these queries to test the system:
• "AI OR artificial intelligence"
• "electric vehicles Tesla"
• "cryptocurrency bitcoin"
• "climate change"
• "technology innovation"
• "healthcare medical"
• "smartphone iPhone Samsung"
• "gaming console PlayStation Xbox"
╔════════════════════════════════════════════════════════════════════════════╗
║ SYSTEM REQUIREMENTS ║
╚════════════════════════════════════════════════════════════════════════════╝
✓ Node.js 14.0 or higher
✓ npm (comes with Node.js)
✓ Modern web browser (Chrome, Firefox, Edge, Safari)
✓ 4GB RAM minimum (8GB recommended)
✓ Internet connection
✓ 500MB free disk space
╔════════════════════════════════════════════════════════════════════════════╗
║ ADDITIONAL DOCUMENTATION ║
╚════════════════════════════════════════════════════════════════════════════╝
For more detailed information, see:
• REQUIREMENTS.txt - Complete technical requirements
• QUICK_START_GUIDE.txt - Detailed step-by-step guide
• README.md - Project overview and features
╔════════════════════════════════════════════════════════════════════════════╗
║ QUICK COMMAND REFERENCE ║
╚════════════════════════════════════════════════════════════════════════════╝
Install dependencies: npm install
Start server (normal): npm start
Start server (dev mode): npm run dev
Stop server: Ctrl+C
Check Node.js version: node --version
Check npm version: npm --version
═══════════════════════════════════════════════════════════════════════════════
🚀 YOU'RE READY TO ANALYZE SENTIMENT! 🚀
═══════════════════════════════════════════════════════════════════════════════
Happy Analyzing! 📊 🎉 ✨
═══════════════════════════════════════════════════════════════════════════════