|
1 | | -# ÉLITE Frontend |
2 | | - |
3 | | -## Folder Structure & File Explanations |
4 | | - |
5 | | -### 📁 frontend/ |
6 | | - |
7 | | -Main project folder for the frontend React application. |
8 | | - |
9 | | -#### 📁 node_modules/ |
10 | | - |
11 | | -Contains all installed packages and dependencies. Managed automatically by Bun. |
12 | | - |
13 | | -#### 📁 public/ |
14 | | - |
15 | | -- `kit_2025.jpg`: Static assets (images, etc.) served directly. Not processed by Webpack/Vite. |
16 | | - |
17 | | -#### 📁 src/ |
18 | | - |
19 | | -Source code for the React app. |
20 | | - |
21 | | -##### 📁 api/ |
22 | | - |
23 | | -- `config.jsx`: API configuration, base URLs, and utility functions for making HTTP requests. |
24 | | - |
25 | | -##### 📁 components/ |
26 | | - |
27 | | -Reusable UI components, organized by feature: |
28 | | - |
29 | | -- **cart/**: Cart-related UI (CartItem, CartSummary, QuantitySelector) |
30 | | -- **common/**: Shared UI (Button, Loader, RatingStars) |
31 | | -- **filters/**: Product filtering UI (Availability, Brand, Category, Price, etc.) |
32 | | -- **layout/**: Layout components (Footer, Nav, Sidebar) |
33 | | -- **product/**: Product display (ProductCard, ProductList) |
34 | | - |
35 | | -##### 📁 hooks/ |
36 | | - |
37 | | -Custom React hooks for business logic: |
38 | | - |
39 | | -- **cartHook/useCart.js**: Cart state and logic |
40 | | -- **productHook/**: (future product-related hooks) |
41 | | - |
| 1 | +# ÉLITE |
| 2 | + |
| 3 | +ÉLITE is a full-stack e-commerce platform built with React and Vite on the frontend, and powered by Bun, Express, and MongoDB on the backend. |
| 4 | +It features product browsing with filters and sorting, cart management, secure authentication using JSON Web Token, and admin-controlled product CRUD operations. |
| 5 | +Designed with a layered architecture and Redux-based state management, it is structured for scalability, maintainability, and production-grade deployment. |
| 6 | + |
| 7 | + |
| 8 | ++## Features |
| 9 | ++- Product catalog with filter UI, sorting, and infinite scroll |
| 10 | ++- Product details view with image gallery and related items |
| 11 | ++- Cart management with quantity updates |
| 12 | ++- User authentication (signup/signin) and profile management |
| 13 | ++- Admin-only product creation, updates, and deletion |
| 14 | ++ |
| 15 | ++## Tech Stack |
| 16 | ++**Frontend:** React 19, Vite, Redux Toolkit, React Router, Tailwind CSS v4, Axios, Framer Motion |
| 17 | ++**Backend:** Bun runtime, Express 5, MongoDB + Mongoose, JWT auth, CORS, Multer |
| 18 | ++ |
| 19 | ++## Project Structure |
| 20 | ++- `frontend/` React app (Vite) |
| 21 | ++- `backend/` Express API |
| 22 | ++- `backend/src/routes/` API routes |
| 23 | ++- `backend/src/controllers/` business logic |
| 24 | ++- `backend/src/models/` Mongoose schemas |
| 25 | ++ |
| 26 | ++## Getting Started |
| 27 | ++### Prerequisites |
| 28 | ++- Bun (for both frontend and backend) |
| 29 | ++- MongoDB (local or Atlas) |
| 30 | ++ |
| 31 | ++### Setup |
| 32 | ++1. Install dependencies: |
| 33 | ++```bash |
| 34 | ++cd backend |
| 35 | ++bun install |
| 36 | ++cd ../frontend |
| 37 | ++bun install |
| 38 | ++``` |
42 | 39 | ##### 📁 pages/ |
43 | 40 |
|
44 | 41 | Top-level pages for routing: |
|
0 commit comments