Sistema Generador de Documentación de Proyectos

# ARCHITECTURE.md ## High-Level System Overview This project is a [brief description of the system, e.g., "web application for managing user tasks"]. It follows a **modular monolith** architectural style, where all components are deployed as a single unit but organized into distinct modules with clear boundaries. ## Architectural Style - **Modular Monolith**: All code resides in a single deployable unit, but is structured into independent modules (e.g., `user`, `task`, `notification`). This balances simplicity with maintainability. - **Event-Driven**: Internal communication between modules uses an event bus for asynchronous operations (e.g., sending notifications after task creation). ## Main Components and Responsibilities - **API Gateway**: Handles incoming HTTP requests, routes them to appropriate modules, and manages authentication/authorization. - **User Module**: Manages user registration, login, profile updates, and role management. - **Task Module**: Handles task creation, assignment, status updates, and deletion. - **Notification Module**: Sends email/push notifications for events like task assignments or deadlines. - **Database Layer**: Uses PostgreSQL for persistent storage, with separate schemas per module. - **Event Bus**: Implements RabbitMQ for asynchronous message passing between modules. ## Folder/Project Structure Explanation ``` src/ ├── api/ # API gateway and route definitions ├── modules/ # Business logic modules (user, task, notification) ├── shared/ # Common utilities, middleware, and configurations ├── config/ # Environment-specific configuration files ├── tests/ # Unit and integration tests └── docs/ # Documentation files ``` ## Data Flow Between Components 1. **User Request**: Client sends HTTP request to API Gateway. 2. **Authentication**: Gateway validates JWT token and forwards request to appropriate module. 3. **Business Logic**: Module processes request, interacts with its database schema. 4. **Event Emission**: Module publishes events (e.g., `task.created`) to the event bus. 5. **Asynchronous Processing**: Other modules (e.g., Notification) consume events and perform actions (e.g., send email). 6. **Response**: Gateway returns response to client. ## External Integrations - **PostgreSQL**: Primary database for all modules. - **RabbitMQ**: Message broker for event-driven communication. - **SendGrid**: Email service for notifications. - **Redis**: Caching layer for session management and rate limiting. ## Authentication/Authorization Approach - **Authentication**: JWT-based tokens issued upon login, validated by API Gateway. - **Authorization**: Role-based access control (RBAC) with roles like `admin`, `user`, `viewer`. Permissions are checked within each module. ## Scalability and Deployment Considerations - **Horizontal Scaling**: The modular monolith can be replicated across multiple instances behind a load balancer. - **Database Scaling**: Use read replicas for query-heavy operations; consider sharding for future growth. - **Caching**: Redis reduces database load for frequently accessed data. - **Containerization**: Deployed via Docker and orchestrated with Kubernetes for auto-scaling and resilience. ## Future Extensibility Considerations - **Microservices Migration**: Modules can be extracted into independent services if needed, due to clear boundaries. - **Plugin System**: Support for third-party integrations via defined APIs. - **Event Sourcing**: Potential to adopt event sourcing for audit trails and complex workflows. --- # PRODUCT.md ## Product Overview and Purpose This product is a **task management system** designed to help teams organize, assign, and track work efficiently. It simplifies project workflows by providing a centralized platform for task creation, collaboration, and progress monitoring. ## Target Users/Personas - **Project Managers**: Oversee task assignments, deadlines, and team workload. - **Team Members**: Create, update, and complete tasks assigned to them. - **Administrators**: Manage user roles, permissions, and system configurations. ## Core Features - **Task Creation and Assignment**: Users can create tasks with descriptions, due dates, and assign them to team members. - **Status Tracking**: Tasks have statuses (e.g., To Do, In Progress, Done) that can be updated. - **Notifications**: Email alerts for task assignments, updates, and approaching deadlines. - **User Management**: Registration, login, profile management, and role assignment. ## Secondary/Supporting Features - **Search and Filtering**: Find tasks by keywords, status, or assignee. - **Comments**: Add notes or discussions to tasks. - **Dashboard**: Overview of pending tasks, deadlines, and team activity. ## User Workflows 1. **Task Creation**: User logs in -> Clicks "Create Task" -> Fills form (title, description, assignee, due date) -> Submits -> Task appears in list. 2. **Task Completion**: User views assigned tasks -> Updates status to "In Progress" -> Completes work -> Changes status to "Done" -> Notification sent to manager. 3. **User Onboarding**: Admin creates account -> User receives welcome email -> Logs in -> Accesses tasks. ## Use Cases - **Project Kickoff**: Manager creates tasks for a new project, assigns them to team members. - **Daily Standup**: Team members update task statuses and discuss blockers. - **Deadline Reminder**: System sends notification 24 hours before a task's due date. ## Business Rules - Tasks cannot be deleted once marked as "Done" (archived instead). - Only admins can assign tasks to users outside their team. - Notifications are sent only for tasks with due dates within 7 days. ## Non-Functional Requirements - **Performance**: API response time under 200ms for 95% of requests. - **Security**: All data encrypted in transit (HTTPS) and at rest (AES-256). Passwords hashed with bcrypt. - **Usability**: Intuitive UI with minimal clicks for common actions; mobile-responsive design. ## Product Vision To become the go-to task management tool for small to medium-sized teams, enabling seamless collaboration and productivity through simplicity and reliability. --- # CONTRIBUTING.md ## Development Setup 1. Clone the repository. 2. Install dependencies: `npm install` (or `pip install -r requirements.txt`). 3. Set up environment variables (see `.env.example`). 4. Run database migrations: `npm run migrate`. 5. Start development server: `npm run dev`. ## Branching Strategy - **Main branch**: `main` - production-ready code. - **Feature branches**: `feature/ ` - for new features. - **Bug fix branches**: `fix/ ` - for bug fixes. - **Release branches**: `release/ ` - for preparing releases. ## Commit Message Conventions Use [Conventional Commits](https://www.conventionalcommits.org/): - `feat:` for new features. - `fix:` for bug fixes. - `docs:` for documentation changes. - `chore:` for maintenance tasks. - Example: `feat: add task assignment feature` ## Pull Request Guidelines - Keep PRs small and focused (max 400 lines). - Include a clear description of changes and motivation. - Reference related issues (e.g., `Closes #123`). - Ensure all tests pass and linting is clean. ## Code Style and Linting Standards - Use ESLint for JavaScript/TypeScript (config in `.eslintrc`). - Follow Prettier formatting rules (config in `.prettierrc`). - Use consistent naming conventions (camelCase for variables, PascalCase for classes). ## Testing Requirements - Write unit tests for all new functions (Jest/Mocha). - Include integration tests for API endpoints. - Maintain minimum 80% code coverage. - Run tests locally before pushing: `npm test`. ## Documentation Requirements - Update `README.md` for any new features or configuration changes. - Add JSDoc comments for public APIs. - Document complex logic with inline comments. ## Review and Approval Process - PRs require at least one approval from a maintainer. - Address all review comments before merging. - Squash commits before merging to `main`. --- # README.md # Task Manager [![Build Status](https://img.shields.io/badge/build-passing-brightgreen)](https://example.com) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-1.0.0-blue)](https://example.com) A simple yet powerful task management system for teams to organize, assign, and track work efficiently. ## Problem Statement Teams often struggle with scattered task tracking across emails, spreadsheets, and chat apps, leading to missed deadlines and confusion. This project provides a centralized solution. ## Key Features - Create, assign, and track tasks with statuses. - Receive email notifications for updates and deadlines. - Manage users and roles with admin controls. - Search and filter tasks by keywords or assignee. ## Tech Stack - **Backend**: Node.js with Express - **Database**: PostgreSQL - **Message Broker**: RabbitMQ - **Caching**: Redis - **Authentication**: JWT - **Deployment**: Docker + Kubernetes ## Installation 1. Clone the repo: ```bash git clone https://github.com/your-org/task-manager.git cd task-manager ``` 2. Install dependencies: ```bash npm install ``` 3. Copy `.env.example` to `.env` and configure variables: ```bash cp .env.example .env ``` 4. Run database migrations: ```bash npm run migrate ``` ## Environment Variables | Variable | Description | Default | |----------|-------------|---------| | `DATABASE_URL` | PostgreSQL connection string | `postgres://localhost:5432/tasks` | | `JWT_SECRET` | Secret key for JWT tokens | `your-secret-key` | | `RABBITMQ_URL` | RabbitMQ connection URL | `amqp://localhost` | | `REDIS_URL` | Redis connection URL | `redis://localhost:6379` | ## How to Run ### Development ```bash npm run dev ``` Server starts at `http://localhost:3000`. ### Production ```bash npm run build npm start ``` Or use Docker: ```bash docker-compose up ``` ## Basic Usage Examples - **Create a task**: ```bash curl -X POST http://localhost:3000/api/tasks \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{"title": "Fix login bug", "assignee": "user@example.com"}' ``` - **List tasks**: ```bash curl http://localhost:3000/api/tasks \ -H "Authorization: Bearer " ``` ## Project Structure Overview ``` src/ ├── api/ # API routes and middleware ├── modules/ # Business logic (user, task, notification) ├── shared/ # Utilities and configurations ├── config/ # Environment settings ├── tests/ # Test files └── docs/ # Documentation ``` ## Additional Documentation - [Architecture Overview](ARCHITECTURE.md) - [Product Details](PRODUCT.md) - [Contributing Guidelines](CONTRIBUTING.md)

Sistema Generador de Documentación de Proyectos

Contenido del PromptGuardar

Uso

Referencias

Discusión