🛍️ IS-Shop - E-Commerce Backend

A Promising NestJS e-commerce backend with complete authentication, product catalog, shopping cart, and order management system.

🚀 Features

🔐 Authentication & Authorization

• JWT-based authentication with access/refresh tokens
• Google OAuth 2.0 integration
• Role-based access control (RBAC)
• Guard system for route protection
• Token management and refresh token rotation

🏪 Product Management

• Complete product catalog with items, variants, and images
• Hierarchical category system
• Product attributes (brands, colors, sizes)
• Product reviews and ratings system
• Image upload with Cloudinary integration

🛒 Shopping Experience

• Shopping cart management
• User address management
• Order processing with status tracking
• Inventory management
• Order calculations and pricing

⚡ Performance & Optimization

• Redis caching with decorator-based cache invalidation
• Response serialization and transformation

🛡️ Security & Validation

• Input validation with class-validator
• SQL injection protection
• XSS protection
• File upload validation
• Environment-based configuration

🏗️ Architecture

src/
├── common/           # Shared utilities, pipes, interceptors
├── modules/          # Feature modules
│   ├── auth/         # Authentication & authorization
│   ├── users/        # User management
│   ├── products/     # Product catalog
│   ├── attributes/   # Product attributes
│   ├── categories/   # Category management
│   ├── reviews/      # Product reviews
│   ├── carts/        # Shopping cart
│   ├── orders/       # Order processing
│   ├── cache/        # Redis caching
│   └── cloudinary/   # Image upload service
└── config/           # Application configuration

🛠️ Technologies

• Framework: NestJS 10+
• Language: TypeScript
• Database: PostgreSQL with TypeORM
• Cache: Redis
• File Storage: Cloudinary
• Authentication: JWT, Google OAuth 2.0
• Validation: class-validator, class-transformer
• Testing: Jest (configurable)
• API Documentation: Swagger (configurable)

📋 Prerequisites

• Node.js 18+
• PostgreSQL 14+
• Redis 7+
• Cloudinary account
• Google OAuth credentials

🔧 Installation

1. Clone the repository

git clone https://github.com/yourusername/is-shop.git
cd is-shop/backend

2. Install dependencies

npm install

3. Set up environment variables

cp .env.example .env

4. Configure environment variables (see below)

5. Run database migrations

npm run migration:run

6. Start the application

# Development
npm run start:dev

# Production
npm run build
npm run start:prod

⚙️ Environment Configuration

Create a .env file in the backend directory:

# Server
PORT=3000
NODE_ENV=development
FRONTEND_URL=http://localhost:3001

# Database
POSTGRES_HOST=localhost
POSTGRES_PORT=5432
POSTGRES_USER=your_db_user
POSTGRES_PASSWORD=your_db_password
POSTGRES_DATABASE=is_shop

# Redis
REDIS_URL=redis://localhost:6379

# Cloudinary (for image uploads)
CLOUDINARY_NAME=your_cloud_name
CLOUDINARY_API_KEY=your_api_key
CLOUDINARY_API_SECRET=your_api_secret

# Google OAuth
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
GOOGLE_CALLBACK_URL=http://localhost:3000/api/auth/google/callback

# JWT
JWT_SECRET=your_jwt_secret_key_change_in_production
JWT_EXPIRATION=900 # 15 minutes in seconds
JWT_REFRESH_SECRET=your_jwt_refresh_secret_change_in_production
JWT_REFRESH_EXPIRATION=604800 # 7 days in seconds

---

📚 API Documentation

The API uses OpenAPI 3.0 specification with Swagger UI for interactive documentation. Once the application is running:

1. Visit http://127.0.0.1:3000/api/v1/docs in your browser
2. Explore all available endpoints
3. Try out API calls directly from the browser
4. View request/response schemas
5. See authentication requirements for each endpoint

Authentication in Swagger

To test protected endpoints in Swagger:

1. Use the /auth/login endpoint to get tokens
2. Click the "Authorize" button (top-right in Swagger UI)
3. Enter your JWT token: Bearer <your-access-token>
4. Now you can test authenticated endpoints

---

📊 API Versioning

The API uses URL versioning (/api/v1/). Future updates will maintain backward compatibility through:

• New endpoints in /api/v2/
• Deprecation warnings for older endpoints
• Graceful migration paths

---

🔮 Roadmap

• Payment gateway integration (Stripe)
• Email notifications (Nodemailer)
• Wishlist functionality
• Coupon and discount system
• Analytics dashboard

---