Spaces:
Running
Running
James McCool
commited on
Commit
·
1bcf29b
1
Parent(s):
e74f850
Add comprehensive BUILD_GUIDE.md for building a MongoDB Data Viewer React app, detailing setup, CSS architecture, component design, and deployment to Hugging Face. Update DataTable component sort indicator from '↕️' to '⇵' for improved clarity.
Browse files- BUILD_GUIDE.md +398 -0
- src/components/DataTable.jsx +2 -2
BUILD_GUIDE.md
ADDED
@@ -0,0 +1,398 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# 🚀 Building a React App with shadcn/ui Styling & Sorting Tables
|
2 |
+
|
3 |
+
## 📋 Table of Contents
|
4 |
+
1. [Project Overview](#project-overview)
|
5 |
+
2. [Prerequisites](#prerequisites)
|
6 |
+
3. [Step-by-Step Build Process](#step-by-step-build-process)
|
7 |
+
4. [File Structure & Purpose](#file-structure--purpose)
|
8 |
+
5. [Key Implementation Details](#key-implementation-details)
|
9 |
+
6. [Customization Guide](#customization-guide)
|
10 |
+
7. [Deployment to Hugging Face](#deployment-to-hugging-face)
|
11 |
+
8. [Troubleshooting](#troubleshooting)
|
12 |
+
|
13 |
+
---
|
14 |
+
|
15 |
+
## 🎯 Project Overview
|
16 |
+
|
17 |
+
This guide shows you how to build a **MongoDB Data Viewer** - a React application with:
|
18 |
+
- ✨ **Modern shadcn/ui styling** (custom CSS implementation)
|
19 |
+
- 📊 **Interactive data tables** with sorting functionality
|
20 |
+
- 🔄 **Real-time data refresh** capabilities
|
21 |
+
- 📱 **Responsive design** for all devices
|
22 |
+
- 🎨 **Professional UI/UX** without external CSS frameworks
|
23 |
+
|
24 |
+
**Why This Approach?**
|
25 |
+
- **No Tailwind CSS dependencies** - avoids compatibility issues
|
26 |
+
- **Custom CSS variables** - easy theming and customization
|
27 |
+
- **Modular components** - maintainable and scalable
|
28 |
+
- **Clean architecture** - follows React best practices
|
29 |
+
|
30 |
+
---
|
31 |
+
|
32 |
+
## 🔧 Prerequisites
|
33 |
+
|
34 |
+
### **Required Software:**
|
35 |
+
- **Node.js** (version 14+ recommended)
|
36 |
+
- **npm** (comes with Node.js)
|
37 |
+
- **Git** (for version control)
|
38 |
+
- **Code editor** (VS Code recommended)
|
39 |
+
|
40 |
+
### **Knowledge Requirements:**
|
41 |
+
- Basic **React** concepts (components, hooks, state)
|
42 |
+
- Basic **JavaScript** (ES6+, async/await)
|
43 |
+
- Basic **CSS** understanding
|
44 |
+
- Basic **Git** commands
|
45 |
+
|
46 |
+
---
|
47 |
+
|
48 |
+
## 🏗️ Step-by-Step Build Process
|
49 |
+
|
50 |
+
### **Phase 1: Project Setup**
|
51 |
+
|
52 |
+
#### **Step 1: Create React App**
|
53 |
+
```bash
|
54 |
+
npx create-react-app mongodb-data-viewer
|
55 |
+
cd mongodb-data-viewer
|
56 |
+
```
|
57 |
+
|
58 |
+
#### **Step 2: Clean Up Default Files**
|
59 |
+
Remove unnecessary files:
|
60 |
+
- `src/logo.svg`
|
61 |
+
- `src/reportWebVitals.js`
|
62 |
+
- `src/setupTests.js`
|
63 |
+
- `public/logo*.png`
|
64 |
+
- `public/manifest.json`
|
65 |
+
- `public/robots.txt`
|
66 |
+
|
67 |
+
#### **Step 3: Install Dependencies**
|
68 |
+
```bash
|
69 |
+
npm install @radix-ui/react-slot
|
70 |
+
npm install -D tailwindcss postcss autoprefixer
|
71 |
+
```
|
72 |
+
|
73 |
+
### **Phase 2: CSS Architecture**
|
74 |
+
|
75 |
+
#### **Step 4: Create Custom CSS System**
|
76 |
+
Create `src/index.css` with:
|
77 |
+
- CSS variables for theming
|
78 |
+
- Utility classes (similar to Tailwind)
|
79 |
+
- Component-specific styles
|
80 |
+
- Responsive design rules
|
81 |
+
|
82 |
+
#### **Step 5: Set Up PostCSS (Optional)**
|
83 |
+
```bash
|
84 |
+
npx tailwindcss init -p
|
85 |
+
```
|
86 |
+
*Note: We'll use custom CSS instead of Tailwind*
|
87 |
+
|
88 |
+
### **Phase 3: Component Architecture**
|
89 |
+
|
90 |
+
#### **Step 6: Create Utility Functions**
|
91 |
+
Create `src/lib/utils.js`:
|
92 |
+
```javascript
|
93 |
+
import { clsx } from "clsx"
|
94 |
+
import { twMerge } from "tailwind-merge"
|
95 |
+
|
96 |
+
export function cn(...inputs) {
|
97 |
+
return twMerge(clsx(inputs))
|
98 |
+
}
|
99 |
+
```
|
100 |
+
|
101 |
+
#### **Step 7: Build UI Components**
|
102 |
+
Create component files:
|
103 |
+
- `src/components/ui/button.jsx`
|
104 |
+
- `src/components/ui/table.jsx`
|
105 |
+
|
106 |
+
#### **Step 8: Create Main Data Component**
|
107 |
+
Create `src/components/DataTable.jsx` with:
|
108 |
+
- State management for data
|
109 |
+
- Sorting functionality
|
110 |
+
- Loading states
|
111 |
+
- Error handling
|
112 |
+
|
113 |
+
### **Phase 4: App Integration**
|
114 |
+
|
115 |
+
#### **Step 9: Update Main App**
|
116 |
+
Modify `src/App.js` to:
|
117 |
+
- Import custom components
|
118 |
+
- Use custom CSS classes
|
119 |
+
- Create responsive layout
|
120 |
+
|
121 |
+
#### **Step 10: Configure Entry Point**
|
122 |
+
Update `src/index.js` to:
|
123 |
+
- Remove unused imports
|
124 |
+
- Import custom CSS
|
125 |
+
- Render main App component
|
126 |
+
|
127 |
+
---
|
128 |
+
|
129 |
+
## 📁 File Structure & Purpose
|
130 |
+
|
131 |
+
```
|
132 |
+
mongodb-data-viewer/
|
133 |
+
├── .git/ # Git repository
|
134 |
+
├── .gitignore # Git ignore rules
|
135 |
+
├── package.json # Dependencies & scripts
|
136 |
+
├── package-lock.json # Locked dependency versions
|
137 |
+
├── README.md # Project documentation
|
138 |
+
├── BUILD_GUIDE.md # This guide
|
139 |
+
├── public/ # Static assets
|
140 |
+
│ ├── index.html # Main HTML template
|
141 |
+
│ └── favicon.ico # Browser icon
|
142 |
+
└── src/ # Source code
|
143 |
+
├── index.js # App entry point
|
144 |
+
├── index.css # Custom CSS system
|
145 |
+
├── App.js # Main app component
|
146 |
+
├── App.css # Basic React styling (required for Streamlit)
|
147 |
+
├── App.test.js # Test file
|
148 |
+
└── components/ # Reusable components
|
149 |
+
├── DataTable.jsx # Main data display component
|
150 |
+
└── ui/ # UI component library
|
151 |
+
├── button.jsx # Button component
|
152 |
+
└── table.jsx # Table components
|
153 |
+
```
|
154 |
+
|
155 |
+
### **File Purpose Breakdown:**
|
156 |
+
|
157 |
+
#### **Root Level Files:**
|
158 |
+
- **`package.json`**: Defines dependencies, scripts, and project metadata
|
159 |
+
- **`.gitignore`**: Specifies which files Git should ignore
|
160 |
+
- **`README.md`**: Project documentation and Hugging Face configuration
|
161 |
+
|
162 |
+
#### **Public Directory:**
|
163 |
+
- **`index.html`**: HTML template that React renders into
|
164 |
+
- **`favicon.ico`**: Browser tab icon (required for professional appearance)
|
165 |
+
|
166 |
+
#### **Source Directory:**
|
167 |
+
- **`index.js`**: JavaScript entry point that bootstraps the React app
|
168 |
+
- **`index.css`**: Custom CSS system with shadcn/ui design tokens
|
169 |
+
- **`App.js`**: Main application component that orchestrates the UI
|
170 |
+
- **`App.css`**: Basic React styling (required for Streamlit compatibility)
|
171 |
+
- **`App.test.js`**: Test file for the main App component
|
172 |
+
|
173 |
+
#### **Components Directory:**
|
174 |
+
- **`DataTable.jsx`**: Core business logic for displaying and sorting data
|
175 |
+
- **`ui/button.jsx`**: Reusable button component with consistent styling
|
176 |
+
- **`ui/table.jsx`**: Table components for structured data display
|
177 |
+
|
178 |
+
---
|
179 |
+
|
180 |
+
## 🔑 Key Implementation Details
|
181 |
+
|
182 |
+
### **1. Custom CSS System**
|
183 |
+
```css
|
184 |
+
:root {
|
185 |
+
--background: #ffffff;
|
186 |
+
--foreground: #020817;
|
187 |
+
--primary: #0f172a;
|
188 |
+
--primary-foreground: #f8fafc;
|
189 |
+
/* ... more variables */
|
190 |
+
}
|
191 |
+
```
|
192 |
+
|
193 |
+
**Why Custom CSS?**
|
194 |
+
- **No framework dependencies** - avoids compatibility issues
|
195 |
+
- **Full control** - customize every aspect of styling
|
196 |
+
- **Performance** - no unused CSS classes
|
197 |
+
- **Maintainability** - clear, organized structure
|
198 |
+
|
199 |
+
### **2. Component State Management**
|
200 |
+
```javascript
|
201 |
+
const [data, setData] = useState([]);
|
202 |
+
const [loading, setLoading] = useState(true);
|
203 |
+
const [error, setError] = useState(null);
|
204 |
+
const [sortConfig, setSortConfig] = useState({ key: null, direction: 'asc' });
|
205 |
+
```
|
206 |
+
|
207 |
+
**State Structure:**
|
208 |
+
- **`data`**: Array of objects to display in table
|
209 |
+
- **`loading`**: Boolean for loading states
|
210 |
+
- **`error`**: String for error messages
|
211 |
+
- **`sortConfig`**: Object tracking sort column and direction
|
212 |
+
|
213 |
+
### **3. Sorting Algorithm**
|
214 |
+
```javascript
|
215 |
+
const sortData = (key) => {
|
216 |
+
let direction = 'asc';
|
217 |
+
|
218 |
+
if (sortConfig.key === key) {
|
219 |
+
if (sortConfig.direction === 'asc') {
|
220 |
+
direction = 'desc';
|
221 |
+
} else if (sortConfig.direction === 'desc') {
|
222 |
+
setSortConfig({ key: null, direction: 'none' });
|
223 |
+
return;
|
224 |
+
}
|
225 |
+
}
|
226 |
+
|
227 |
+
setSortConfig({ key, direction });
|
228 |
+
};
|
229 |
+
```
|
230 |
+
|
231 |
+
**Three-State Sorting:**
|
232 |
+
1. **Ascending** (↑): First click, sorts A→Z
|
233 |
+
2. **Descending** (↓): Second click, sorts Z→A
|
234 |
+
3. **None** (↕️): Third click, returns to original order
|
235 |
+
|
236 |
+
### **4. Responsive Design**
|
237 |
+
```css
|
238 |
+
.container {
|
239 |
+
width: 100%;
|
240 |
+
margin-left: auto;
|
241 |
+
margin-right: auto;
|
242 |
+
padding-left: 2rem;
|
243 |
+
padding-right: 2rem;
|
244 |
+
}
|
245 |
+
|
246 |
+
@media (min-width: 1400px) {
|
247 |
+
.container {
|
248 |
+
max-width: 1400px;
|
249 |
+
}
|
250 |
+
}
|
251 |
+
```
|
252 |
+
|
253 |
+
**Responsive Features:**
|
254 |
+
- **Mobile-first** approach
|
255 |
+
- **Flexible containers** that adapt to screen size
|
256 |
+
- **Consistent spacing** across devices
|
257 |
+
- **Touch-friendly** interactions
|
258 |
+
|
259 |
+
---
|
260 |
+
|
261 |
+
## 🎨 Customization Guide
|
262 |
+
|
263 |
+
### **Changing Colors**
|
264 |
+
Modify CSS variables in `src/index.css`:
|
265 |
+
```css
|
266 |
+
:root {
|
267 |
+
--primary: #your-color-here;
|
268 |
+
--background: #your-bg-color;
|
269 |
+
/* ... */
|
270 |
+
}
|
271 |
+
```
|
272 |
+
|
273 |
+
### **Adding New Columns**
|
274 |
+
1. **Update mock data** in `DataTable.jsx`
|
275 |
+
2. **Add table header** with sorting capability
|
276 |
+
3. **Add table cell** for new data
|
277 |
+
4. **Update sorting logic** if needed
|
278 |
+
|
279 |
+
### **Modifying Table Styling**
|
280 |
+
Edit table-specific CSS in `src/index.css`:
|
281 |
+
```css
|
282 |
+
.table th {
|
283 |
+
/* Custom header styles */
|
284 |
+
}
|
285 |
+
|
286 |
+
.table td {
|
287 |
+
/* Custom cell styles */
|
288 |
+
}
|
289 |
+
```
|
290 |
+
|
291 |
+
### **Adding New Features**
|
292 |
+
- **Search**: Add input field and filter logic
|
293 |
+
- **Pagination**: Implement page-based data loading
|
294 |
+
- **Export**: Add CSV/PDF download functionality
|
295 |
+
- **Charts**: Integrate data visualization libraries
|
296 |
+
|
297 |
+
---
|
298 |
+
|
299 |
+
## 🚀 Deployment to Hugging Face
|
300 |
+
|
301 |
+
### **1. Configure README.md**
|
302 |
+
```yaml
|
303 |
+
---
|
304 |
+
title: MongoDB Data Viewer
|
305 |
+
emoji: 📊
|
306 |
+
colorFrom: blue
|
307 |
+
colorTo: indigo
|
308 |
+
sdk: static
|
309 |
+
pinned: false
|
310 |
+
app_build_command: npm run build
|
311 |
+
app_file: build/index.html
|
312 |
+
---
|
313 |
+
```
|
314 |
+
|
315 |
+
### **2. Build the App**
|
316 |
+
```bash
|
317 |
+
npm run build
|
318 |
+
```
|
319 |
+
|
320 |
+
### **3. Push to Git Repository**
|
321 |
+
```bash
|
322 |
+
git add .
|
323 |
+
git commit -m "Add MongoDB data viewer with sorting"
|
324 |
+
git push origin main
|
325 |
+
```
|
326 |
+
|
327 |
+
### **4. Hugging Face Integration**
|
328 |
+
- **Create new Space** on Hugging Face
|
329 |
+
- **Connect Git repository**
|
330 |
+
- **Automatic deployment** will begin
|
331 |
+
- **Monitor build logs** for any issues
|
332 |
+
|
333 |
+
---
|
334 |
+
|
335 |
+
## 🔧 Troubleshooting
|
336 |
+
|
337 |
+
### **Common Issues & Solutions:**
|
338 |
+
|
339 |
+
#### **Build Errors**
|
340 |
+
- **Problem**: Missing dependencies
|
341 |
+
- **Solution**: Run `npm install` and check `package.json`
|
342 |
+
|
343 |
+
#### **Styling Issues**
|
344 |
+
- **Problem**: CSS not loading
|
345 |
+
- **Solution**: Verify `index.css` import in `index.js`
|
346 |
+
|
347 |
+
#### **Component Errors**
|
348 |
+
- **Problem**: Import/export mismatches
|
349 |
+
- **Solution**: Check file paths and component names
|
350 |
+
|
351 |
+
#### **Deployment Issues**
|
352 |
+
- **Problem**: Hugging Face build fails
|
353 |
+
- **Solution**: Verify `app_file` points to `build/index.html`
|
354 |
+
|
355 |
+
### **Performance Optimization:**
|
356 |
+
- **Lazy loading** for large datasets
|
357 |
+
- **Memoization** for expensive calculations
|
358 |
+
- **Debouncing** for search inputs
|
359 |
+
- **Virtual scrolling** for very long tables
|
360 |
+
|
361 |
+
---
|
362 |
+
|
363 |
+
## 📚 Next Steps & Enhancements
|
364 |
+
|
365 |
+
### **Immediate Improvements:**
|
366 |
+
1. **Add search functionality** across all columns
|
367 |
+
2. **Implement pagination** for large datasets
|
368 |
+
3. **Add data export** (CSV, JSON)
|
369 |
+
4. **Create dark mode** toggle
|
370 |
+
|
371 |
+
### **Advanced Features:**
|
372 |
+
1. **Real-time updates** with WebSocket
|
373 |
+
2. **Advanced filtering** with multiple criteria
|
374 |
+
3. **Data visualization** with charts
|
375 |
+
4. **User authentication** and permissions
|
376 |
+
|
377 |
+
### **Backend Integration:**
|
378 |
+
1. **MongoDB connection** with Node.js/Express
|
379 |
+
2. **RESTful API** endpoints
|
380 |
+
3. **Database optimization** with indexing
|
381 |
+
4. **Caching layer** for performance
|
382 |
+
|
383 |
+
---
|
384 |
+
|
385 |
+
## 🎯 Summary
|
386 |
+
|
387 |
+
This guide has walked you through building a **professional-grade React application** with:
|
388 |
+
|
389 |
+
✅ **Clean architecture** following React best practices
|
390 |
+
✅ **Custom CSS system** without external dependencies
|
391 |
+
✅ **Interactive data tables** with sorting functionality
|
392 |
+
✅ **Responsive design** for all devices
|
393 |
+
✅ **Professional styling** that matches shadcn/ui design system
|
394 |
+
✅ **Easy deployment** to Hugging Face Spaces
|
395 |
+
|
396 |
+
The result is a **maintainable, scalable, and beautiful** application that you can easily customize and extend for your specific needs.
|
397 |
+
|
398 |
+
**Happy coding! 🚀**
|
src/components/DataTable.jsx
CHANGED
@@ -69,10 +69,10 @@ const DataTable = () => {
|
|
69 |
|
70 |
// Get sort indicator for column headers
|
71 |
const getSortIndicator = (key) => {
|
72 |
-
if (sortConfig.key !== key) return '
|
73 |
if (sortConfig.direction === 'asc') return '↑';
|
74 |
if (sortConfig.direction === 'desc') return '↓';
|
75 |
-
return '
|
76 |
};
|
77 |
|
78 |
const fetchFromMongoDB = async () => {
|
|
|
69 |
|
70 |
// Get sort indicator for column headers
|
71 |
const getSortIndicator = (key) => {
|
72 |
+
if (sortConfig.key !== key) return '⇵';
|
73 |
if (sortConfig.direction === 'asc') return '↑';
|
74 |
if (sortConfig.direction === 'desc') return '↓';
|
75 |
+
return '⇵';
|
76 |
};
|
77 |
|
78 |
const fetchFromMongoDB = async () => {
|