ccjk 3.7.3 → 3.7.4

package/templates/industry/devops/en/ci-cd-pipeline.md

@@ -1,410 +0,0 @@
-# DevOps CI/CD Pipeline Template
-
-## GitHub Actions Workflow
-
-### Complete CI/CD Pipeline
-
-```yaml
-# .github/workflows/ci-cd.yml
-name: CI/CD Pipeline
-
-on:
-  push:
-    branches: [main, develop]
-  pull_request:
-    branches: [main]
-
-env:
-  NODE_VERSION: '20'
-  REGISTRY: ghcr.io
-  IMAGE_NAME: ${{ github.repository }}
-
-jobs:
-  # ===================
-  # Lint & Type Check
-  # ===================
-  lint:
-    name: Lint & Type Check
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: pnpm/action-setup@v2
-        with:
-          version: 8
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-          cache: 'pnpm'
-
-      - run: pnpm install --frozen-lockfile
-      - run: pnpm lint
-      - run: pnpm typecheck
-
-  # ===================
-  # Unit Tests
-  # ===================
-  test:
-    name: Unit Tests
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: pnpm/action-setup@v2
-        with:
-          version: 8
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-          cache: 'pnpm'
-
-      - run: pnpm install --frozen-lockfile
-      - run: pnpm test:coverage
-
-      - uses: codecov/codecov-action@v3
-        with:
-          files: ./coverage/lcov.info
-
-  # ===================
-  # Build
-  # ===================
-  build:
-    name: Build
-    runs-on: ubuntu-latest
-    needs: [lint, test]
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: pnpm/action-setup@v2
-        with:
-          version: 8
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-          cache: 'pnpm'
-
-      - run: pnpm install --frozen-lockfile
-      - run: pnpm build
-
-      - uses: actions/upload-artifact@v4
-        with:
-          name: build
-          path: dist/
-
-  # ===================
-  # Security Scan
-  # ===================
-  security:
-    name: Security Scan
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Run Trivy vulnerability scanner
-        uses: aquasecurity/trivy-action@master
-        with:
-          scan-type: 'fs'
-          scan-ref: '.'
-          severity: 'CRITICAL,HIGH'
-
-  # ===================
-  # Docker Build
-  # ===================
-  docker:
-    name: Docker Build & Push
-    runs-on: ubuntu-latest
-    needs: [build, security]
-    if: github.ref == 'refs/heads/main'
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: docker/setup-buildx-action@v3
-
-      - uses: docker/login-action@v3
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - uses: docker/metadata-action@v5
-        id: meta
-        with:
-          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
-          tags: |
-            type=sha
-            type=ref,event=branch
-            type=semver,pattern={{version}}
-
-      - uses: docker/build-push-action@v5
-        with:
-          context: .
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
-
-  # ===================
-  # Deploy Staging
-  # ===================
-  deploy-staging:
-    name: Deploy to Staging
-    runs-on: ubuntu-latest
-    needs: [docker]
-    environment: staging
-    if: github.ref == 'refs/heads/main'
-
-    steps:
-      - name: Deploy to staging
-        run: |
-          # Add deployment commands here
-          echo "Deploying to staging..."
-
-  # ===================
-  # E2E Tests
-  # ===================
-  e2e:
-    name: E2E Tests
-    runs-on: ubuntu-latest
-    needs: [deploy-staging]
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: pnpm/action-setup@v2
-        with:
-          version: 8
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-          cache: 'pnpm'
-
-      - run: pnpm install --frozen-lockfile
-      - run: pnpm exec playwright install --with-deps
-
-      - name: Run E2E tests
-        run: pnpm test:e2e
-        env:
-          BASE_URL: https://staging.example.com
-
-      - uses: actions/upload-artifact@v4
-        if: failure()
-        with:
-          name: playwright-report
-          path: playwright-report/
-
-  # ===================
-  # Deploy Production
-  # ===================
-  deploy-prod:
-    name: Deploy to Production
-    runs-on: ubuntu-latest
-    needs: [e2e]
-    environment: production
-    if: github.ref == 'refs/heads/main'
-
-    steps:
-      - name: Deploy to production
-        run: |
-          echo "Deploying to production..."
-```
-
-## Dockerfile
-
-```dockerfile
-# Build stage
-FROM node:20-alpine AS builder
-
-WORKDIR /app
-
-# Install pnpm
-RUN corepack enable && corepack prepare pnpm@latest --activate
-
-# Install dependencies
-COPY package.json pnpm-lock.yaml ./
-RUN pnpm install --frozen-lockfile
-
-# Build
-COPY . .
-RUN pnpm build
-
-# Production stage
-FROM node:20-alpine AS runner
-
-WORKDIR /app
-
-ENV NODE_ENV=production
-
-# Create non-root user
-RUN addgroup --system --gid 1001 nodejs && \
-    adduser --system --uid 1001 appuser
-
-# Copy built files
-COPY --from=builder /app/dist ./dist
-COPY --from=builder /app/package.json ./
-
-# Install production dependencies only
-RUN corepack enable && \
-    corepack prepare pnpm@latest --activate && \
-    pnpm install --prod --frozen-lockfile
-
-USER appuser
-
-EXPOSE 3000
-
-CMD ["node", "dist/index.js"]
-```
-
-## Docker Compose
-
-```yaml
-# docker-compose.yml
-version: '3.8'
-
-services:
-  app:
-    build: .
-    ports:
-      - '3000:3000'
-    environment:
-      - DATABASE_URL=postgres://user:pass@db:5432/app
-      - REDIS_URL=redis://cache:6379
-    depends_on:
-      db:
-        condition: service_healthy
-      cache:
-        condition: service_started
-    healthcheck:
-      test: ['CMD', 'curl', '-f', 'http://localhost:3000/health']
-      interval: 30s
-      timeout: 10s
-      retries: 3
-
-  db:
-    image: postgres:16-alpine
-    volumes:
-      - postgres_data:/var/lib/postgresql/data
-    environment:
-      - POSTGRES_USER=user
-      - POSTGRES_PASSWORD=pass
-      - POSTGRES_DB=app
-    healthcheck:
-      test: ['CMD-SHELL', 'pg_isready -U user -d app']
-      interval: 5s
-      timeout: 5s
-      retries: 5
-
-  cache:
-    image: redis:7-alpine
-    volumes:
-      - redis_data:/data
-
-volumes:
-  postgres_data:
-  redis_data:
-```
-
-## Kubernetes Deployment
-
-```yaml
-# k8s/deployment.yaml
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: app
-  labels:
-    app: app
-spec:
-  replicas: 3
-  selector:
-    matchLabels:
-      app: app
-  template:
-    metadata:
-      labels:
-        app: app
-    spec:
-      containers:
-        - name: app
-          image: ghcr.io/org/app:latest
-          ports:
-            - containerPort: 3000
-          resources:
-            requests:
-              memory: '256Mi'
-              cpu: '100m'
-            limits:
-              memory: '512Mi'
-              cpu: '500m'
-          livenessProbe:
-            httpGet:
-              path: /health
-              port: 3000
-            initialDelaySeconds: 30
-            periodSeconds: 10
-          readinessProbe:
-            httpGet:
-              path: /ready
-              port: 3000
-            initialDelaySeconds: 5
-            periodSeconds: 5
-          env:
-            - name: DATABASE_URL
-              valueFrom:
-                secretKeyRef:
-                  name: app-secrets
-                  key: database-url
----
-apiVersion: v1
-kind: Service
-metadata:
-  name: app
-spec:
-  selector:
-    app: app
-  ports:
-    - port: 80
-      targetPort: 3000
-  type: ClusterIP
----
-apiVersion: networking.k8s.io/v1
-kind: Ingress
-metadata:
-  name: app
-  annotations:
-    kubernetes.io/ingress.class: nginx
-    cert-manager.io/cluster-issuer: letsencrypt-prod
-spec:
-  tls:
-    - hosts:
-        - app.example.com
-      secretName: app-tls
-  rules:
-    - host: app.example.com
-      http:
-        paths:
-          - path: /
-            pathType: Prefix
-            backend:
-              service:
-                name: app
-                port:
-                  number: 80
-```
-
-## Best Practices
-
-1. **Fast Feedback**: Run linting and unit tests first
-2. **Parallel Jobs**: Run independent jobs in parallel
-3. **Caching**: Cache dependencies and Docker layers
-4. **Security**: Scan for vulnerabilities before deployment
-5. **Environment Gates**: Use environment protection rules
-6. **Rollback Plan**: Tag releases for easy rollback

package/templates/industry/web-dev/en/api-design.md

@@ -1,299 +0,0 @@
-# API Design Best Practices Template
-
-## RESTful API Design
-
-### Resource Naming Conventions
-
-```
-✅ Good:
-GET    /users                 # List users
-GET    /users/{id}            # Get specific user
-POST   /users                 # Create user
-PUT    /users/{id}            # Replace user
-PATCH  /users/{id}            # Update user
-DELETE /users/{id}            # Delete user
-
-GET    /users/{id}/orders     # User's orders
-GET    /orders/{id}/items     # Order's items
-
-❌ Bad:
-GET    /getUsers
-GET    /user/fetch/{id}
-POST   /createUser
-GET    /users/{id}/getOrders
-```
-
-### Query Parameters
-
-```
-# Pagination
-GET /users?page=2&limit=20
-
-# Filtering
-GET /users?status=active&role=admin
-
-# Sorting
-GET /users?sort=created_at:desc,name:asc
-
-# Field selection
-GET /users?fields=id,name,email
-
-# Search
-GET /users?search=john
-
-# Combined
-GET /users?status=active&sort=name:asc&page=1&limit=10
-```
-
-### Response Format
-
-```typescript
-// Success Response
-interface SuccessResponse<T> {
-  success: true
-  data: T
-  meta?: {
-    pagination?: {
-      page: number
-      limit: number
-      total: number
-      totalPages: number
-    }
-  }
-}
-
-// Error Response
-interface ErrorResponse {
-  success: false
-  error: {
-    code: string           // Machine-readable code
-    message: string        // Human-readable message
-    details?: Array<{
-      field?: string
-      message: string
-    }>
-  }
-}
-```
-
-### Example Responses
-
-```json
-// GET /users - Success
-{
-  "success": true,
-  "data": [
-    { "id": "1", "name": "John", "email": "john@example.com" }
-  ],
-  "meta": {
-    "pagination": {
-      "page": 1,
-      "limit": 20,
-      "total": 150,
-      "totalPages": 8
-    }
-  }
-}
-
-// POST /users - Validation Error
-{
-  "success": false,
-  "error": {
-    "code": "VALIDATION_ERROR",
-    "message": "Invalid input data",
-    "details": [
-      { "field": "email", "message": "Invalid email format" },
-      { "field": "password", "message": "Must be at least 8 characters" }
-    ]
-  }
-}
-```
-
-## HTTP Status Codes
-
-```
-2xx Success:
-  200 OK              - GET, PUT, PATCH success
-  201 Created         - POST success
-  204 No Content      - DELETE success
-
-4xx Client Error:
-  400 Bad Request     - Invalid syntax
-  401 Unauthorized    - No/invalid authentication
-  403 Forbidden       - Authenticated but not authorized
-  404 Not Found       - Resource doesn't exist
-  409 Conflict        - Resource conflict (duplicate)
-  422 Unprocessable   - Validation error
-  429 Too Many        - Rate limit exceeded
-
-5xx Server Error:
-  500 Internal Error  - Server failure
-  502 Bad Gateway     - Upstream failure
-  503 Unavailable     - Service overloaded
-  504 Gateway Timeout - Upstream timeout
-```
-
-## Authentication
-
-### JWT Token Structure
-
-```typescript
-// Access Token (short-lived: 15min)
-interface AccessToken {
-  sub: string        // User ID
-  email: string
-  role: string
-  iat: number        // Issued at
-  exp: number        // Expiration
-}
-
-// Refresh Token (long-lived: 7 days)
-interface RefreshToken {
-  sub: string
-  jti: string        // Token ID (for revocation)
-  iat: number
-  exp: number
-}
-```
-
-### Auth Flow
-
-```
-1. Login
-POST /auth/login
-{ "email": "...", "password": "..." }
-→ { "accessToken": "...", "refreshToken": "..." }
-
-2. Access Protected Resource
-GET /users
-Authorization: Bearer <accessToken>
-
-3. Refresh Token
-POST /auth/refresh
-{ "refreshToken": "..." }
-→ { "accessToken": "...", "refreshToken": "..." }
-
-4. Logout
-POST /auth/logout
-{ "refreshToken": "..." }
-```
-
-## Rate Limiting
-
-```typescript
-// Response Headers
-{
-  'X-RateLimit-Limit': '100',        // Max requests per window
-  'X-RateLimit-Remaining': '95',     // Remaining requests
-  'X-RateLimit-Reset': '1640000000', // Window reset timestamp
-  'Retry-After': '60'                // Seconds until retry (on 429)
-}
-```
-
-## Versioning
-
-```
-# URL Path (Recommended)
-/api/v1/users
-/api/v2/users
-
-# Header
-Accept: application/vnd.api+json;version=1
-
-# Query Parameter
-/api/users?version=1
-```
-
-## OpenAPI Specification
-
-```yaml
-openapi: 3.0.3
-info:
-  title: My API
-  version: 1.0.0
-  description: API for managing resources
-
-servers:
-  - url: https://api.example.com/v1
-
-paths:
-  /users:
-    get:
-      summary: List users
-      tags: [Users]
-      parameters:
-        - name: page
-          in: query
-          schema:
-            type: integer
-            default: 1
-        - name: limit
-          in: query
-          schema:
-            type: integer
-            default: 20
-            maximum: 100
-      responses:
-        '200':
-          description: Success
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/UserList'
-
-    post:
-      summary: Create user
-      tags: [Users]
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/CreateUser'
-      responses:
-        '201':
-          description: Created
-        '422':
-          description: Validation error
-
-components:
-  schemas:
-    User:
-      type: object
-      properties:
-        id:
-          type: string
-        name:
-          type: string
-        email:
-          type: string
-          format: email
-      required: [id, name, email]
-
-    CreateUser:
-      type: object
-      properties:
-        name:
-          type: string
-          minLength: 1
-        email:
-          type: string
-          format: email
-        password:
-          type: string
-          minLength: 8
-      required: [name, email, password]
-```
-
-## Best Practices Checklist
-
-- [ ] Use nouns for resources, not verbs
-- [ ] Use plural nouns (/users not /user)
-- [ ] Use proper HTTP methods
-- [ ] Return appropriate status codes
-- [ ] Implement pagination for lists
-- [ ] Support filtering and sorting
-- [ ] Use consistent error format
-- [ ] Implement rate limiting
-- [ ] Version your API
-- [ ] Document with OpenAPI