aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 4feb096ba1275e30a4bbeaee6b7291da07907d81 (plain) (blame)
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
# E-Commerce Clothing Brand Website

A modern e-commerce platform for a clothing brand similar to turntupfashion.com, built with Next.js, Express, and MongoDB.

## Project Overview

This project provides a complete e-commerce solution with the following features:
- Responsive product catalog with filtering and search
- User authentication and account management
- Shopping cart and checkout process
- Payment processing integration
- Admin dashboard for product and order management
- Multi-currency support

## Tech Stack

- **Frontend**: Next.js, React, Tailwind CSS
- **Backend**: Node.js, Express.js
- **Database**: MongoDB with Mongoose
- **Authentication**: JWT
- **Payment**: Stripe API

## Getting Started

### Prerequisites

- Node.js (v16+)
- MongoDB
- Stripe account for payment processing

### Installation

1. Clone the repository
```bash
git clone https://github.com/yourusername/ecom.git
cd ecom
```

2. Set up the frontend
```bash
cd frontend
npm install
cp .env.example .env.local
# Edit .env.local with your environment variables
```

3. Set up the backend
```bash
cd ../backend
npm install
cp .env.example .env
# Edit .env with your environment variables
```

4. Start development servers

Frontend:
```bash
cd frontend
npm run dev
```

Backend:
```bash
cd backend
npm run dev
```

## Project Structure

The project follows a clear separation between frontend and backend:

- `/frontend`: Next.js application with pages, components, and assets
- `/backend`: Express.js API with controllers, models, and routes
- `/admin`: Admin dashboard (optional separate application)
- `/shared`: Shared code and types between frontend and backend

## Documentation

For more detailed documentation, see:
- [Project Plan](./docs/project-plan.md) - Complete project overview and timeline
- [Implementation Guide](./docs/implementation.md) - Step-by-step implementation details
- [Component Structure](./docs/components.md) - Frontend component organization

## License

MIT