Système d'invite pour générateur de documentation de projet

# 1 ARCHITECTURE.md # Architecture ## High-Level Overview Modular monolith application with clear domain boundaries, deployed as a single deployable unit. The system follows a layered architecture with strict dependency rules, allowing future extraction into microservices if required. ## Architectural Style - **Modular monolith** - single deployment unit with internal module boundaries - **Event-driven** within the domain layer for decoupled communication - **RESTful API** for external integrations ## Main Components | Component | Responsibility | |---|---| | **API Gateway** | Request routing, authentication, rate limiting | | **Application Core** | Business logic, use case orchestration | | **Domain Modules** | Encapsulated business capabilities (e.g., User, Order, Payment) | | **Infrastructure** | Database access, external service clients, message brokers | | **Shared Kernel** | Common utilities, cross-cutting concerns (logging, error handling) | ## Folder Structure ``` src/ ├── api/ # Controllers, middleware, route definitions ├── application/ # Use cases, DTOs, application services ├── domain/ # Entities, value objects, domain services, aggregates ├── infrastructure/ # Repositories, external clients, database context └── shared/ # Common utilities, extensions, constants ``` ## Data Flow 1. **Request** enters via API Gateway 2. **Authentication** and validation occur at middleware level 3. **Application layer** orchestrates use case execution 4. **Domain layer** enforces business rules and invariants 5. **Infrastructure layer** persists data or calls external services 6. **Response** returns through the same path ## External Integrations - **PostgreSQL** - primary data store - **Redis** - caching and session storage - **Stripe API** - payment processing - **SendGrid** - email notifications - **S3-compatible storage** - file uploads ## Authentication / Authorization - **JWT-based** authentication with refresh token rotation - **Role-based access control (RBAC)** at the API layer - **Policy-based authorization** within the application layer ## Scalability and Deployment - **Containerized** with Docker, orchestrated via Kubernetes - **Horizontal scaling** for stateless API instances - **Database read replicas** for read-heavy workloads - **CI/CD pipeline** with automated testing and staged deployments - **Environment-based configuration** via environment variables ## Future Extensibility - Module boundaries align with potential microservice extraction points - Event bus abstraction allows swapping in-memory events for message brokers - Plugin architecture for third-party integrations --- # 2 PRODUCT.md # Product Documentation ## Product Overview A comprehensive order management platform that streamlines the entire order lifecycle - from creation through fulfillment and payment reconciliation. The platform provides real-time visibility into order status, automated payment processing, and seamless integration with inventory systems. ## Target Users | Persona | Description | |---|---| | **Operations Manager** | Oversees order flow, handles exceptions, monitors KPIs | | **Customer Support Agent** | Resolves order issues, processes refunds, communicates with customers | | **Finance Analyst** | Reviews payment transactions, reconciles discrepancies | | **System Administrator** | Manages user access, configures business rules | ## Core Features - **Order creation and management** - create, edit, cancel, and track orders - **Payment processing** - secure credit card and digital wallet payments - **Inventory synchronization** - real-time stock level updates - **Automated notifications** - email and SMS updates at key milestones - **Reporting dashboard** - real-time metrics on orders, revenue, and fulfillment ## Secondary Features - Bulk order import/export (CSV) - Custom order status workflows - Audit logging for compliance - Customer address book management - Discount and promotion engine ## User Workflows 1. **Order Placement** - Customer places order → system validates inventory → payment captured → order confirmed 2. **Order Fulfillment** - Warehouse picks items → shipment created → tracking number assigned → customer notified 3. **Returns Processing** - Customer requests return → approval workflow → refund issued → inventory restocked ## Use Cases - **UC-01**: Customer places an order with multiple items and applies a promo code - **UC-02**: Operations manager updates order status to "Shipped" with tracking information - **UC-03**: Finance analyst generates a daily revenue report filtered by payment method - **UC-04**: Support agent processes a full refund for a damaged item ## Business Rules - Orders can only be cancelled within 24 hours of placement - Refunds require manager approval above $500 - Inventory cannot go negative - orders fail if stock is insufficient - Promo codes are single-use per customer ## Non-Functional Requirements - **Performance** - API responses under 300ms (p95), dashboard loads under 2 seconds - **Security** - PCI-DSS compliant payment handling, data encrypted at rest and in transit - **Usability** - Intuitive interface, all core actions accessible within 3 clicks - **Availability** - 99.9% uptime target, automated failover for critical services ## Product Vision To become the definitive order management solution for mid-sized e-commerce businesses, offering enterprise-grade capabilities with startup-level simplicity and speed of deployment. --- # 3 CONTRIBUTING.md # Contributing Guidelines ## Development Setup ```bash # Clone and install git clone cd cp .env.example .env npm install # Start development environment docker-compose up -d npm run dev ``` ## Branching Strategy - **main** - production-ready code, protected branch - **develop** - integration branch for features - **feature/[ticket-id]-[description]** - new features or improvements - **fix/[ticket-id]-[description]** - bug fixes - **hotfix/[ticket-id]-[description]** - urgent production fixes ## Commit Message Conventions Follow [Conventional Commits](https://www.conventionalcommits.org/): ``` feat(scope): description fix(scope): description docs(scope): description refactor(scope): description test(scope): description ``` Example: `feat(order): add bulk order export endpoint` ## Pull Request Guidelines - Target the `develop` branch (or `main` for hotfixes) - Include ticket reference in title and description - Keep PRs focused - maximum 400 lines changed - Provide clear description of changes and testing performed - Add screenshots for UI changes ## Code Style and Linting - **ESLint** with project configuration (run `npm run lint`) - **Prettier** for formatting (run `npm run format`) - Follow existing patterns in the codebase - Use TypeScript strict mode - no `any` types ## Testing Requirements - All new features require unit tests (minimum 80% coverage) - Integration tests for API endpoints - Update existing tests when modifying behavior - Run full test suite before submitting: `npm test` ## Documentation Requirements - Update README.md for user-facing changes - Update ARCHITECTURE.md for structural changes - Add JSDoc comments for new public functions - Document environment variables in `.env.example` ## Review and Approval - Minimum 1 approval from a maintainer - All review comments must be resolved - CI pipeline must pass (lint, tests, build) - Squash and merge strategy --- # 4 README.md # OrderFlow - Order Management Platform [![Build Status](https://img.shields.io/badge/build-passing-brightgreen)](https://example.com) [![Version](https://img.shields.io/badge/version-2.1.0-blue)](https://example.com) [![License](https://img.shields.io/badge/license-MIT-green)](https://example.com) ## Problem Statement E-commerce businesses struggle with fragmented order management across multiple channels, leading to errors, delayed fulfillment, and poor customer experience. OrderFlow centralizes order processing, payment handling, and inventory sync in one platform. ## Key Features - **Unified order management** - all channels, one dashboard - **Automated payment processing** - Stripe integration with PCI compliance - **Real-time inventory sync** - prevent overselling - **Smart notifications** - keep customers informed automatically - **Analytics dashboard** - actionable business insights ## Tech Stack | Layer | Technology | |---|---| | **Frontend** | React 18, TypeScript, Tailwind CSS | | **Backend** | Node.js 20, Express, TypeScript | | **Database** | PostgreSQL 16, Redis 7 | | **Infrastructure** | Docker, Kubernetes, GitHub Actions | ## Installation ### Prerequisites - Node.js 20+ - Docker and Docker Compose - PostgreSQL 16 (or use Docker) ### Setup ```bash # Clone repository git clone https://github.com/your-org/orderflow.git cd orderflow # Install dependencies npm install # Configure environment cp .env.example .env # Edit .env with your database credentials and API keys # Start database docker-compose up -d postgres redis # Run migrations npm run migrate # Start development server npm run dev ``` ## Environment Variables | Variable | Description | Default | |---|---|---| | `DATABASE_URL` | PostgreSQL connection string | `postgres://localhost:5432/orderflow` | | `REDIS_URL` | Redis connection string | `redis://localhost:6379` | | `JWT_SECRET` | JWT signing secret | (required) | | `STRIPE_API_KEY` | Stripe secret key | (required) | | `SENDGRID_API_KEY` | Email service key | (required) | ## Running the Project ### Development ```bash npm run dev ``` Access at `http://localhost:3000` ### Production ```bash npm run build npm start ``` ### Docker Deployment ```bash docker-compose up -d --build ``` ## Basic Usage ```bash # Create an order curl -X POST http://localhost:3000/api/orders \ -H "Content-Type: application/json" \ -H "Authorization: Bearer " \ -d '{"items": [{"productId": "123", "quantity": 2}]}' # Get order status curl http://localhost:3000/api/orders/456 \ -H "Authorization: Bearer " ``` ## Project Structure ``` src/ ├── api/ # HTTP layer - routes, controllers ├── application/ # Use cases and business workflows ├── domain/ # Core business logic and entities ├── infrastructure/ # Database, external services └── shared/ # Common utilities ``` ## Documentation - [Architecture](ARCHITECTURE.md) - system design and technical details - [Product](PRODUCT.md) - features, workflows, and business rules - [Contributing](CONTRIBUTING.md) - developer guidelines and setup ## License MIT License - see [LICENSE](LICENSE) file for details.

Système d'invite pour générateur de documentation de projet

Contenu du PromptEnregistrer

Utilisation

Références

Discussion