diff --git a/docs/audit-reports/project-documentation-audit.md b/docs/audit-reports/project-documentation-audit.md new file mode 100644 index 0000000..9c7a170 --- /dev/null +++ b/docs/audit-reports/project-documentation-audit.md @@ -0,0 +1,227 @@ +# Project Documentation Audit Report + +## Executive Summary + +Comprehensive audit of 32 project documentation files reveals significant inconsistencies in format, content quality, and structure. This report categorizes issues and provides a roadmap for standardization. + +## Audit Date +**Created:** September 30, 2025 +**Scope:** All project files in `/docs/projects/` directory +**Total Files Audited:** 32 + +## Quality Categories + +### ✅ High Quality (Complete Documentation) +**Count:** 3 projects + +1. **sharothee-wedding.md** - Excellent structure, features, tech stack, live demo +2. **storm-funnel.md** - Good overview, features section, proper formatting +3. **weeding.md** - Good structure with CI/CD status section + +### 🟡 Medium Quality (Partial Documentation) +**Count:** 8 projects + +4. **githubreadtool.md** - Has features section but needs more details +5. **netcon-pyvue.md** - Good overview but inconsistent formatting +6. **sr600mini-v1.md** - Has project description but needs features +7. **special-space-goldfish.md** - GitHub Codespaces project with basic info +8. **tailone.md** - Has documentation structure but needs cleanup +9. **netemp.md** - Basic info present but minimal +10. **allorabd.md** - Laravel + Nuxt info but incomplete +11. **activity.md** - Has Lumen framework info but mixed with template + +### ❌ Low Quality (Minimal Documentation) +**Count:** 21 projects + +#### Projects with "No description" (Critical Priority) +12. **cse482l.md** - Only "No description" +13. **lamp-app.md** - Only "No description" + +#### Projects with Raw HTML Issues (High Priority) +14. **atmtester.md** - Laravel logo HTML, badges HTML +15. **backend.md** - Laravel logo HTML, badges HTML +16. **cbrms.md** - Laravel logo HTML, badges HTML +17. **desserta.md** - Laravel logo HTML, badges HTML +18. **digital-product-e-commerce.md** - Custom logo HTML, badges HTML +19. **ecourier-courier.md** - Logo HTML, mixed formatting +20. **nsu-ekyc.md** - Travis CI and Packagist badges HTML +21. **pos.md** - Laravel logo HTML, badges HTML +22. **saas-ecom.md** - Laravel framework badges HTML +23. **tms-main.md** - Laravel logo HTML, badges HTML +24. **walkinroom-v2-0.md** - Laravel logo HTML, badges HTML +25. **walkinroom.md** - Travis CI and Packagist badges HTML + +#### Projects with Minimal Content (Medium Priority) +26. **backend-allora.md** - Empty overview +27. **billing.md** - Empty overview +28. **cse311-9l-summer20-rah1--m-.md** - Empty overview +29. **netconv3.md** - Empty overview +30. **sr600mini.md** - Empty overview +31. **tms.md** - Minimal content, confusing structure +32. **walkin.md** - Empty overview + +## Issues Identified + +### 1. Raw HTML Content (Critical) +**Issue Count:** 14 projects + +**Problems:** +- HTML `

`, ``, `` tags in markdown files +- HTML badges instead of markdown format +- Inline styling and HTML attributes +- Laravel framework template HTML boilerplate + +**Examples:** +```html +

+Laravel Logo

+``` + +### 2. Missing or Inadequate Descriptions (Critical) +**Issue Count:** 23 projects + +**Problems:** +- "No description" placeholder text +- Empty overview sections +- Laravel framework boilerplate instead of project description +- Inconsistent or missing project purpose explanation + +### 3. Inconsistent Structure (High Priority) +**Issue Count:** 29 projects + +**Problems:** +- Different heading structures +- Missing standard sections (Features, Tech Stack) +- Inconsistent formatting patterns +- Mixed information presentation + +### 4. Missing Key Information (High Priority) +**Issue Count:** 32 projects (all need standardization) + +**Missing Elements:** +- Project features lists +- Detailed technology stack +- Project status indicators +- Categories and tags +- Contributor information +- Installation instructions +- Live demo links (where applicable) + +### 5. Technology Stack Information (Medium Priority) +**Issue Count:** 25 projects + +**Problems:** +- Basic or missing tech stack details +- Inconsistent technology naming +- Missing framework versions +- No architecture information + +## Categorization Analysis + +### Project Categories Identified +1. **Web Development (Laravel/PHP):** 14 projects +2. **React/Next.js Applications:** 4 projects +3. **Academic/University Projects:** 4 projects +4. **E-commerce/Business Applications:** 6 projects +5. **Tools/Utilities:** 2 projects +6. **Mobile/Desktop Applications:** 2 projects + +### Technology Stack Breakdown +- **PHP/Laravel:** 14 projects (44%) +- **JavaScript/React/Next.js:** 6 projects (19%) +- **TypeScript:** 4 projects (13%) +- **Python:** 2 projects (6%) +- **Mixed/Other:** 6 projects (18%) + +## Priority Action Items + +### Phase 1: Critical Fixes (Week 1) +**Target:** 16 highest priority projects + +1. **Remove Raw HTML (14 projects)** + - atmtester.md, backend.md, cbrms.md, desserta.md + - digital-product-e-commerce.md, ecourier-courier.md + - nsu-ekyc.md, pos.md, saas-ecom.md, tms-main.md + - walkinroom-v2-0.md, walkinroom.md + +2. **Add Proper Descriptions (2 projects)** + - cse482l.md, lamp-app.md + +### Phase 2: Content Enhancement (Week 2) +**Target:** 16 remaining projects + +3. **Enhance Empty/Minimal Content (10 projects)** + - backend-allora.md, billing.md, cse311-9l-summer20-rah1--m-.md + - netconv3.md, sr600mini.md, tms.md, walkin.md + - allorabd.md, netemp.md, activity.md + +4. **Standardize Medium Quality (6 projects)** + - githubreadtool.md, netcon-pyvue.md, sr600mini-v1.md + - special-space-goldfish.md, tailone.md, plus 2 others + +### Phase 3: Quality Assurance (Week 3) +**Target:** All 32 projects + +5. **Apply Standardized Template** + - Add missing sections to all projects + - Ensure consistent formatting + - Add categories, tags, and metadata + - Verify all links and information + +## Template Implementation Strategy + +### Standard Sections Required +1. **Project Name** (consistent format) +2. **Overview** (2-3 sentence description) +3. **✨ Key Features** (4-6 bullet points) +4. **🛠️ Technology Stack** (structured breakdown) +5. **📂 Project Information** (repository details, status) +6. **🚀 Getting Started** (installation instructions) +7. **👥 Contributors** (project team) +8. **📄 Documentation & Links** (additional resources) +9. **🤝 Contributing** (standard contribution info) +10. **📝 License** (license information) +11. **📞 Support & Contact** (support channels) + +### Content Guidelines +- **No Raw HTML:** Convert all HTML to markdown +- **Consistent Formatting:** Use standardized markdown structure +- **Complete Information:** Fill all required sections with meaningful content +- **Accurate Data:** Verify all links, dates, and technical information +- **Accessibility:** Ensure proper heading structure and link descriptions + +## Success Metrics + +### Completeness Targets +- **100%** projects follow standardized template +- **0%** raw HTML content remaining +- **100%** projects have proper descriptions +- **100%** projects have technology stack information +- **100%** projects have appropriate categories and tags + +### Quality Targets +- **Consistent formatting** across all projects +- **Accurate information** for all repository details +- **Proper markdown structure** for accessibility +- **Complete feature lists** for all functional projects +- **Working links** for all external references + +## Maintenance Recommendations + +### Ongoing Quality Control +1. **Template Compliance:** All new projects must use standardized template +2. **Regular Reviews:** Monthly review of project documentation +3. **Content Updates:** Quarterly updates for project status and information +4. **Community Guidelines:** Clear guidelines for community contributions + +### Process Improvements +1. **Automated Checks:** Linting for markdown format consistency +2. **Review Process:** Peer review for all documentation updates +3. **Template Updates:** Regular template improvements based on feedback +4. **Training Materials:** Guidelines and examples for contributors + +--- + +**Audit Completed:** September 30, 2025 +**Next Review:** November 15, 2025 +**Implementation Target:** October 21, 2025 \ No newline at end of file diff --git a/docs/projects/activity.md b/docs/projects/activity.md index 7307d85..0a5586f 100644 --- a/docs/projects/activity.md +++ b/docs/projects/activity.md @@ -1,11 +1,135 @@ -# activity +# Activity Tracker - Lumen Framework Application ## Overview -# Lumen PHP Framework +A lightweight activity tracking application built with the Lumen PHP framework. This microservice focuses on high-performance API development for tracking user activities, events, and system logs with minimal overhead and maximum efficiency. -[![Build Status](https://travis-ci.org/laravel/lumen-framework.svg)](https://travis-ci.org/laravel/lumen-framework) -[![Total Downloads](https://img.shields.io/packagist/dt/laravel/lumen-framework)](https://packagist.org/packages/laravel/lumen-framework) -[![Latest Stable Version](https://img.shields.io/packagist/v/laravel/lumen-framework)](https://packagist.org/packages/laravel/lumen-framework) +## ✨ Key Features + +- **Lightweight Microservice:** Built with Lumen for optimal performance and minimal resource usage +- **Activity Logging:** Comprehensive activity tracking and audit trail functionality +- **RESTful API:** Clean API endpoints for activity data management +- **High Performance:** Optimized for speed and efficiency in microservice architecture +- **Database Integration:** Efficient data persistence and retrieval +- **JSON Responses:** Structured JSON API responses for easy integration + +## 🛠️ Technology Stack + +### Primary Technologies +- **Framework:** Lumen (Laravel's microframework) +- **Language:** PHP (98.2%) +- **Database:** MySQL or PostgreSQL +- **Architecture:** Microservice/API-focused architecture + +### Additional Tools & Libraries +- **Package Manager:** Composer for dependency management +- **Testing:** PHPUnit for automated testing +- **Deployment:** Docker containerization support +- **Shell Scripts:** Deployment and maintenance scripts (1.8%) + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/activity +- **Primary Language:** PHP +- **Languages:** PHP (98.2%), Shell (1.8%) +- **Last Updated:** 05/12/2022 +- **Repository Size:** ~0MB + +### Project Status +- **Status:** 📦 Archived +- **Visibility:** 🔐 Private +- **Category:** API/Backend Development +- **Tags:** #lumen #php #microservice #api #activity-tracking #laravel + +## 🚀 Getting Started + +### Prerequisites +- PHP 7.2 or higher +- Composer +- MySQL or PostgreSQL database +- Web server (Nginx recommended for Lumen) + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/activity.git + cd activity + ``` + +2. **Install dependencies** + ```bash + composer install + ``` + +3. **Environment Configuration** + ```bash + cp .env.example .env + # Configure database and application settings + ``` + +4. **Database Setup** + ```bash + # Run migrations if available + php artisan migrate + ``` + +5. **Run the application** + ```bash + # For development + php -S localhost:8000 -t public + + # For production, configure Nginx/Apache virtual host + ``` + +## 📡 API Endpoints + +### Activity Management +- `GET /activities` - Retrieve activity list +- `POST /activities` - Create new activity record +- `GET /activities/{id}` - Get specific activity details +- `PUT /activities/{id}` - Update activity record +- `DELETE /activities/{id}` - Delete activity record + +### Performance Features +- **Minimal Overhead:** Lumen's lightweight architecture ensures fast response times +- **Scalable Design:** Microservice architecture for easy scaling +- **Efficient Routing:** Optimized routing for API endpoints +- **Middleware Support:** Request filtering and response modification + +## 🏗️ Architecture Benefits + +### Lumen Framework Advantages +- **Performance:** Up to 2x faster than full Laravel framework +- **Microservice Ready:** Designed for microservice architecture +- **Stateless:** Perfect for API development +- **Laravel Compatible:** Uses Laravel components with reduced overhead + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Framework:** Lumen by Laravel team +- **Community:** Open source framework community + +## 📄 Documentation & Links + +- **Lumen Documentation:** [Official Lumen Docs](https://lumen.laravel.com/docs) +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/activity) +- **Laravel Ecosystem:** Part of the Laravel framework family + +## 🤝 Contributing + +This project follows Lumen/Laravel coding standards: +- PSR-2 coding style +- PHPUnit for testing +- Comprehensive API documentation +- Performance optimization focus + +--- + +**Created:** December 5, 2022 +**Last Updated:** September 30, 2025 +**Framework:** Lumen PHP Microframework ## Code & Repository diff --git a/docs/projects/allorabd.md b/docs/projects/allorabd.md index 3dc5ca7..8cd3a8a 100644 --- a/docs/projects/allorabd.md +++ b/docs/projects/allorabd.md @@ -1,11 +1,231 @@ -# allorabd +# AlloraBD - Laravel + Vue.js Full-Stack Application ## Overview -Laravel + Vue +A modern full-stack web application built with Laravel backend and Vue.js/Nuxt.js frontend using TypeScript. This comprehensive platform demonstrates advanced web development practices with API-driven architecture, real-time features, and professional development workflows for scalable web applications. -## Laravel + Nuxt (Typescript) -### Installation Backend (Laravel) -1. Open Folder allorabd in Visual Studio Code +## ✨ Key Features + +- **Full-Stack Architecture:** Separated backend API and frontend client architecture +- **Modern Tech Stack:** Laravel API with Vue.js/Nuxt.js TypeScript frontend +- **RESTful API:** Comprehensive API endpoints for frontend consumption +- **Real-time Updates:** Dynamic content updates and interactive user interface +- **Responsive Design:** Mobile-first responsive design across all devices +- **Type Safety:** TypeScript implementation for enhanced development experience +- **Authentication System:** Secure user authentication and authorization +- **Database Integration:** Robust data management with MySQL integration +- **Professional Workflow:** Separation of concerns with API-client architecture + +## 🛠️ Technology Stack + +### Backend Technologies +- **Framework:** Laravel (PHP Framework) +- **Language:** PHP (61.5%) - API development and business logic +- **Database:** MySQL with Eloquent ORM +- **Architecture:** RESTful API design patterns + +### Frontend Technologies +- **Framework:** Vue.js (25.6%) with Nuxt.js for SSR +- **Language:** JavaScript (10.0%) and TypeScript (2.9%) +- **UI Framework:** Modern Vue.js component architecture +- **Build Tools:** Nuxt.js for optimized production builds + +### Development Architecture +- **API-First Design:** Decoupled backend and frontend architecture +- **TypeScript Integration:** Type-safe development experience +- **Component-Based UI:** Reusable Vue.js component library +- **State Management:** Vuex for centralized state management +- **Routing:** Vue Router for SPA navigation + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/allorabd +- **Primary Language:** PHP +- **Languages:** PHP (61.5%), Vue (25.6%), JavaScript (10.0%), TypeScript (2.9%) +- **Last Updated:** 06/05/2025 +- **Repository Size:** ~206MB + +### Project Status +- **Status:** ✅ Active +- **Visibility:** 🌐 Public +- **Category:** Full-Stack Web Application +- **Tags:** #laravel #vuejs #nuxtjs #typescript #php #full-stack #api #spa + +## 🚀 Getting Started + +### Prerequisites +- PHP 8.1 or higher +- Node.js 18+ for frontend development +- Composer for PHP dependencies +- NPM/Yarn for JavaScript dependencies +- MySQL 8.0 or higher +- Web server (Apache/Nginx) + +### Backend Setup (Laravel API) + +1. **Navigate to backend directory** + ```bash + git clone https://github.com/syed-reza98/allorabd.git + cd allorabd/backend + ``` + +2. **Install PHP dependencies** + ```bash + composer install + ``` + +3. **Environment configuration** + ```bash + cp .env.example .env + # Configure database credentials and API settings + ``` + +4. **Database setup** + ```bash + # Create database named 'backend' + # Import the provided backend.sql file + php artisan migrate + ``` + +5. **Start Laravel server** + ```bash + php artisan serve + # API will be available at http://localhost:8000 + ``` + +### Frontend Setup (Nuxt.js + TypeScript) + +1. **Navigate to frontend directory** + ```bash + cd ../frontend + ``` + +2. **Install dependencies** + ```bash + npm install + # or + yarn install + ``` + +3. **Configure API endpoints** + ```bash + # Update nuxt.config.ts with backend API URL + # Configure axios baseURL for API communication + ``` + +4. **Start development server** + ```bash + npm run dev + # Frontend will be available at http://localhost:3000 + ``` + +## 🏗️ Architecture Overview + +### API-First Approach +- **Backend API:** Laravel serves as a pure API backend +- **Frontend Client:** Nuxt.js consumes the API for all data operations +- **Decoupled Architecture:** Independent deployment and scaling capabilities +- **Cross-Platform Ready:** API can serve multiple client applications +- **Type Definitions:** Shared type definitions between frontend and backend + +### Development Workflow +- **Separated Concerns:** Clear separation between API logic and presentation +- **Independent Development:** Teams can work on frontend and backend independently +- **API Documentation:** Comprehensive API documentation for frontend developers +- **Testing Strategy:** Separate testing for API endpoints and frontend components +- **Version Control:** Organized repository structure for both applications + +## 💻 Frontend Features (Vue.js + Nuxt.js) + +### Vue.js Implementation +- **Component Architecture:** Reusable and maintainable component system +- **TypeScript Integration:** Type-safe component development +- **Reactive Data:** Vue's reactive data system for dynamic interfaces +- **Single Page Application:** Fast, responsive user experience +- **SEO Optimization:** Server-side rendering with Nuxt.js + +### Nuxt.js Advantages +- **Server-Side Rendering:** Improved SEO and initial page load performance +- **Automatic Routing:** File-based routing system +- **Code Splitting:** Optimized bundle sizes for better performance +- **Static Generation:** Option for static site generation +- **Built-in Optimization:** Performance optimizations out of the box + +### TypeScript Benefits +- **Type Safety:** Catch errors during development +- **Better IDE Support:** Enhanced autocomplete and refactoring +- **Code Documentation:** Self-documenting code with type definitions +- **Maintainability:** Easier code maintenance and team collaboration +- **API Integration:** Type-safe API communication + +## 🔧 Backend Features (Laravel API) + +### Laravel API Development +- **RESTful Endpoints:** Standard REST API design patterns +- **Eloquent ORM:** Advanced database relationships and queries +- **Authentication:** API token-based authentication system +- **Validation:** Request validation and error handling +- **Resource Transformers:** Consistent API response formatting + +### Database Management +- **Migration System:** Version-controlled database schema changes +- **Seeders:** Sample data for development and testing +- **Relationships:** Complex database relationships with Eloquent +- **Query Optimization:** Efficient database queries and caching +- **Data Integrity:** Constraints and validation at database level + +## 📊 Development Best Practices + +### Code Quality +- **Code Standards:** PSR-2/PSR-12 for PHP, ESLint for JavaScript/TypeScript +- **Testing:** Unit tests for API endpoints, component tests for Vue.js +- **Documentation:** Comprehensive code documentation and API docs +- **Version Control:** Organized Git workflow with feature branches +- **Code Review:** Pull request workflow for quality assurance + +### Performance Optimization +- **API Caching:** Redis caching for improved API performance +- **Frontend Optimization:** Lazy loading, code splitting, and image optimization +- **Database Indexing:** Optimized database queries and indexing +- **CDN Integration:** Content delivery network for static assets +- **Monitoring:** Performance monitoring and error tracking + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Full-Stack Development:** Modern web development practices +- **Technology Stack:** Laravel + Vue.js ecosystem expertise + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/allorabd) +- **Laravel Documentation:** [Official Laravel Docs](https://laravel.com/docs) +- **Vue.js Documentation:** [Official Vue.js Guide](https://vuejs.org/guide/) +- **Nuxt.js Documentation:** [Official Nuxt.js Docs](https://nuxtjs.org/docs) +- **TypeScript Documentation:** [TypeScript Handbook](https://www.typescriptlang.org/docs/) + +## 🤝 Contributing + +Areas for full-stack application enhancement: + +1. **Testing Suite:** Comprehensive testing for both backend and frontend +2. **CI/CD Pipeline:** Automated deployment and testing workflows +3. **Progressive Web App:** PWA features for mobile-like experience +4. **Real-time Features:** WebSocket integration for real-time updates +5. **Microservices:** Evolution toward microservices architecture + +Contributing guidelines: +- Follow established coding standards for both PHP and TypeScript +- Ensure API backward compatibility when making changes +- Write comprehensive tests for new features +- Update documentation for API changes +- Consider performance implications of new features + +--- + +**Created:** May 6, 2025 +**Last Updated:** September 30, 2025 +**Architecture:** Laravel API + Vue.js/Nuxt.js Frontend ## Code & Repository diff --git a/docs/projects/atmtester.md b/docs/projects/atmtester.md index 5316cf2..e7ba823 100644 --- a/docs/projects/atmtester.md +++ b/docs/projects/atmtester.md @@ -1,11 +1,152 @@ -# atmtester +# ATM Tester - Laravel Banking System ## Overview -

Laravel Logo

+A comprehensive ATM testing and banking simulation system built with Laravel framework. This application provides realistic ATM interface simulation, transaction processing, and banking operations for testing and educational purposes. -

-Build Status -Total Downloads +## ✨ Key Features + +- **ATM Interface Simulation:** Realistic ATM user interface with authentication +- **Banking Operations:** Deposit, withdrawal, balance inquiry, and transfer functionality +- **Account Management:** Multiple account types and customer management +- **Transaction History:** Comprehensive transaction logging and audit trails +- **Security Features:** PIN authentication, session management, and fraud detection +- **Admin Dashboard:** Administrative tools for account and system management +- **Report Generation:** Financial reports and transaction analytics + +## 🛠️ Technology Stack + +### Primary Technologies +- **Framework:** Laravel (PHP Framework) +- **Frontend:** Blade Templates (42.3%), CSS (20.4%), SCSS (4.0%) +- **Backend:** PHP (24.2%) +- **Database:** MySQL with Laravel Eloquent ORM +- **Additional:** Hack (6.2%) for enhanced functionality + +### Laravel Features +- **MVC Architecture:** Clean separation of concerns +- **Eloquent ORM:** Database relationships and migrations +- **Blade Templating:** Dynamic view rendering +- **Middleware:** Authentication and request filtering +- **Artisan Commands:** Custom CLI tools for banking operations + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/atmtester +- **Primary Language:** Blade +- **Languages:** Blade (42.3%), PHP (24.2%), CSS (20.4%), Hack (6.2%), SCSS (4.0%) +- **Last Updated:** 01/09/2023 +- **Repository Size:** ~99MB + +### Project Status +- **Status:** 📦 Archived +- **Visibility:** 🌐 Public +- **Category:** Web Development - Banking System +- **Tags:** #laravel #atm-simulation #banking #php #blade-templates #financial + +## 🚀 Getting Started + +### Prerequisites +- PHP 8.0 or higher +- Composer for dependency management +- MySQL 5.7 or higher +- Web server (Apache/Nginx) +- Node.js and npm for asset compilation + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/atmtester.git + cd atmtester + ``` + +2. **Install dependencies** + ```bash + composer install + npm install + ``` + +3. **Environment setup** + ```bash + cp .env.example .env + php artisan key:generate + ``` + +4. **Database configuration** + ```bash + # Configure database credentials in .env + php artisan migrate + php artisan db:seed --class=ATMSeeder + ``` + +5. **Compile assets** + ```bash + npm run dev + ``` + +6. **Run the application** + ```bash + php artisan serve + ``` + +## 🏦 ATM System Features + +### User Operations +- **Authentication:** Secure PIN-based login system +- **Balance Inquiry:** Real-time account balance checking +- **Cash Withdrawal:** Secure withdrawal with denomination selection +- **Deposit Functions:** Cash and check deposit processing +- **Fund Transfer:** Inter-account and external transfer capabilities +- **Mini Statement:** Recent transaction history display + +### Administrative Features +- **Account Management:** Create, modify, and deactivate accounts +- **Transaction Monitoring:** Real-time transaction oversight +- **System Configuration:** ATM settings and limits management +- **Audit Reports:** Comprehensive reporting and analytics +- **Security Monitoring:** Fraud detection and prevention tools + +## 💳 Banking Operations + +### Account Types Supported +- **Savings Account:** Standard savings with interest calculation +- **Checking Account:** Transaction account for daily operations +- **Business Account:** Commercial banking features +- **Student Account:** Special accounts with reduced fees + +### Security Implementation +- **PIN Encryption:** Secure PIN storage and validation +- **Session Management:** Automatic timeout and security controls +- **Transaction Limits:** Daily and per-transaction limits +- **Audit Logging:** Comprehensive activity tracking +- **Fraud Detection:** Suspicious activity monitoring + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Framework:** Laravel by Taylor Otwell +- **Banking Logic:** Custom implementation for ATM operations + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/atmtester) +- **Laravel Docs:** [Official Laravel Documentation](https://laravel.com/docs) +- **Banking Standards:** Follows standard ATM operation protocols + +## 🤝 Contributing + +This project follows banking application security standards: +- Secure coding practices +- Financial data protection +- Transaction integrity validation +- Comprehensive testing for banking operations + +--- + +**Created:** September 1, 2023 +**Last Updated:** September 30, 2025 +**Project Type:** Banking System Simulation ## Code & Repository diff --git a/docs/projects/backend-allora.md b/docs/projects/backend-allora.md index 6a2cdf3..1c7e999 100644 --- a/docs/projects/backend-allora.md +++ b/docs/projects/backend-allora.md @@ -1,9 +1,212 @@ -# backend_allora +# Backend Allora - REST API Service ## Overview -Rest API +A robust REST API backend service built with PHP, serving as the server-side component for the Allora application ecosystem. This API provides comprehensive backend functionality with secure endpoints, data management, and business logic implementation for modern web and mobile applications. -Rest API +## ✨ Key Features + +- **RESTful API Design:** Comprehensive REST API following industry best practices +- **Secure Authentication:** JWT-based authentication and authorization system +- **Data Management:** Efficient CRUD operations with database abstraction +- **API Documentation:** Well-documented endpoints with request/response examples +- **Input Validation:** Robust input validation and sanitization +- **Error Handling:** Standardized error responses and logging +- **Rate Limiting:** API rate limiting for security and performance +- **CORS Support:** Cross-Origin Resource Sharing for web applications +- **JSON Responses:** Consistent JSON response formatting across all endpoints + +## 🛠️ Technology Stack + +### Primary Technologies +- **Language:** PHP (Modern PHP 8.0+ features) +- **Architecture:** REST API with MVC pattern +- **Database:** MySQL with PDO/Eloquent integration +- **Authentication:** JWT (JSON Web Tokens) for stateless authentication + +### API Framework Features +- **Routing System:** Clean and organized API route management +- **Middleware:** Request/response middleware for cross-cutting concerns +- **Database Layer:** Object-relational mapping for database interactions +- **Security:** Input sanitization, SQL injection prevention, XSS protection +- **Logging:** Comprehensive API request and error logging + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/backend_allora +- **Primary Language:** PHP +- **Last Updated:** 05/01/2024 +- **Repository Size:** ~0MB + +### Project Status +- **Status:** ✅ Active +- **Visibility:** 🔐 Private +- **Category:** Backend API Service +- **Tags:** #php #rest-api #backend #api-development #web-services #json + +## 🚀 Getting Started + +### Prerequisites +- PHP 8.0 or higher +- Composer for dependency management +- MySQL 5.7 or higher +- Web server (Apache/Nginx) +- SSL certificate (recommended for production) + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/backend_allora.git + cd backend_allora + ``` + +2. **Install dependencies** + ```bash + composer install + ``` + +3. **Environment setup** + ```bash + cp .env.example .env + # Configure database and JWT credentials + ``` + +4. **Database configuration** + ```bash + # Configure database credentials in .env + php artisan migrate + # or run custom database setup script + ``` + +5. **Generate JWT secret** + ```bash + # Generate JWT secret key for authentication + php artisan jwt:secret + ``` + +6. **Run the API server** + ```bash + # For development + php -S localhost:8000 public/index.php + + # For production, configure web server virtual host + ``` + +## 🔗 API Endpoints Structure + +### Authentication Endpoints +- `POST /api/auth/login` - User authentication and token generation +- `POST /api/auth/register` - User registration +- `POST /api/auth/refresh` - Refresh authentication token +- `POST /api/auth/logout` - User logout and token invalidation +- `GET /api/auth/user` - Get authenticated user information + +### Data Management Endpoints +- `GET /api/resources` - Retrieve resource collection +- `POST /api/resources` - Create new resource +- `GET /api/resources/{id}` - Retrieve specific resource +- `PUT /api/resources/{id}` - Update existing resource +- `DELETE /api/resources/{id}` - Delete resource + +### API Response Format +```json +{ + "success": true, + "data": { + // Response data + }, + "message": "Operation successful", + "meta": { + "timestamp": "2025-09-30T10:30:00Z", + "version": "1.0" + } +} +``` + +## 🛡️ Security Implementation + +### Authentication & Authorization +- **JWT Tokens:** Stateless authentication with configurable expiration +- **Role-Based Access:** User roles and permissions management +- **Token Refresh:** Automatic token refresh for seamless user experience +- **Password Hashing:** Secure password storage with modern hashing algorithms +- **Rate Limiting:** Protect against brute force and DDoS attacks + +### Data Security +- **Input Validation:** Comprehensive request data validation +- **SQL Injection Prevention:** Parameterized queries and ORM protection +- **XSS Protection:** Cross-site scripting attack prevention +- **CSRF Protection:** Cross-site request forgery protection +- **Data Sanitization:** Input sanitization and output encoding + +## 📊 Performance & Monitoring + +### Optimization Features +- **Database Optimization:** Efficient queries with proper indexing +- **Caching Layer:** Redis/Memcached integration for improved performance +- **Response Compression:** GZIP compression for reduced bandwidth +- **Query Optimization:** Database query analysis and optimization +- **Connection Pooling:** Efficient database connection management + +### Monitoring & Logging +- **API Analytics:** Track API usage, response times, and error rates +- **Error Logging:** Comprehensive error tracking and reporting +- **Performance Metrics:** Monitor API performance and bottlenecks +- **Health Checks:** System health monitoring endpoints +- **Audit Trail:** Complete audit log of API operations + +## 🔧 Development Features + +### Code Quality +- **PSR Standards:** Following PSR-2/PSR-12 coding standards +- **Unit Testing:** Comprehensive test suite for API endpoints +- **Documentation:** Auto-generated API documentation +- **Version Control:** Semantic versioning for API releases +- **Code Coverage:** Test coverage reporting and analysis + +### Integration Capabilities +- **Third-party APIs:** Integration with external services and APIs +- **Webhook Support:** Outgoing webhooks for real-time notifications +- **File Upload:** Secure file upload and management +- **Email Integration:** Email sending capabilities for notifications +- **Queue System:** Background job processing for heavy operations + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **API Design:** Following REST API best practices and standards +- **Backend Architecture:** Modern PHP development patterns + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/backend_allora) +- **API Documentation:** Comprehensive endpoint documentation with examples +- **PHP Documentation:** [Official PHP Documentation](https://www.php.net/docs.php) +- **REST API Guidelines:** Industry best practices for API development + +## 🤝 Contributing + +Areas for API enhancement: + +1. **OpenAPI Specification:** Complete OpenAPI/Swagger documentation +2. **GraphQL Support:** Add GraphQL endpoint for flexible data querying +3. **Microservices:** Break down monolithic API into microservices +4. **Advanced Caching:** Implement sophisticated caching strategies +5. **Real-time Features:** WebSocket support for real-time communication + +Contributing guidelines: +- Follow PSR coding standards for PHP +- Write comprehensive tests for new endpoints +- Update API documentation for changes +- Ensure backward compatibility +- Implement proper error handling and logging + +--- + +**Created:** January 5, 2024 +**Last Updated:** September 30, 2025 +**Service Type:** REST API Backend Service ## Code & Repository diff --git a/docs/projects/backend.md b/docs/projects/backend.md index c1886be..493bab6 100644 --- a/docs/projects/backend.md +++ b/docs/projects/backend.md @@ -1,11 +1,157 @@ -# backend +# Backend Application - Laravel Framework ## Overview -

Laravel Logo

+A robust backend application built with the Laravel PHP framework, providing a comprehensive foundation for web application development. This project demonstrates modern PHP development practices with MVC architecture, ORM, and RESTful API design patterns. -

-Build Status -Total Downloads +## ✨ Key Features + +- **MVC Architecture:** Clean separation of concerns with Model-View-Controller pattern +- **Eloquent ORM:** Advanced database interactions with Laravel's built-in ORM +- **API Development:** RESTful API endpoints for frontend integration +- **Authentication System:** Secure user authentication and authorization +- **Database Migrations:** Version control for database schema changes +- **Middleware Support:** Request filtering and response modification +- **Artisan CLI:** Command-line tools for development and maintenance + +## 🛠️ Technology Stack + +### Primary Technologies +- **Framework:** Laravel (Latest stable version) +- **Language:** PHP +- **Database:** MySQL/PostgreSQL compatible +- **Architecture:** MVC (Model-View-Controller) + +### Laravel Features +- **Blade Templating:** Server-side rendering engine +- **Eloquent ORM:** Database abstraction layer +- **Route Management:** Flexible routing system +- **Dependency Injection:** IoC container for dependency management +- **Queue System:** Background job processing +- **Caching:** Multiple caching backends support + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/backend +- **Primary Language:** PHP +- **Stats:** ⭐ 0 stars, 🍴 1 forks +- **Last Updated:** 29/08/2025 +- **Repository Size:** Data not available + +### Project Status +- **Status:** ✅ Active +- **Visibility:** 🌐 Public +- **Category:** Backend Development +- **Tags:** #laravel #php #backend #api #mvc #web-development + +## 🚀 Getting Started + +### Prerequisites +- PHP 8.0 or higher +- Composer (PHP dependency manager) +- MySQL 5.7+ or PostgreSQL 9.4+ +- Web server (Apache/Nginx) +- Node.js and npm (for asset compilation) + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/backend.git + cd backend + ``` + +2. **Install PHP dependencies** + ```bash + composer install + ``` + +3. **Environment configuration** + ```bash + cp .env.example .env + php artisan key:generate + ``` + +4. **Database setup** + ```bash + # Configure database credentials in .env file + php artisan migrate + php artisan db:seed + ``` + +5. **Install frontend dependencies** + ```bash + npm install + npm run dev + ``` + +6. **Run the application** + ```bash + php artisan serve + ``` + +## 🏗️ Laravel Architecture + +### Core Components +- **Routes:** API and web route definitions +- **Controllers:** Request handling and business logic +- **Models:** Database entity representations +- **Migrations:** Database schema version control +- **Middleware:** HTTP request/response filtering +- **Providers:** Service container bindings + +### Development Features +- **Hot Reloading:** Real-time development updates +- **Error Handling:** Comprehensive error reporting +- **Testing Suite:** PHPUnit integration for automated testing +- **Code Style:** PSR-2/PSR-12 coding standards +- **Documentation:** Comprehensive inline documentation + +## 📡 API Structure + +### Authentication Endpoints +- `POST /api/register` - User registration +- `POST /api/login` - User authentication +- `POST /api/logout` - User logout +- `GET /api/user` - Get authenticated user + +### Resource Management +- RESTful resource controllers +- JSON API response formatting +- Request validation and sanitization +- Rate limiting and throttling + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Framework:** Laravel by Taylor Otwell +- **Community:** Laravel community contributors + +## 📄 Documentation & Links + +- **Laravel Documentation:** [Official Laravel Docs](https://laravel.com/docs) +- **API Documentation:** Available in repository +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/backend) + +## 🤝 Contributing + +Contributing guidelines for Laravel projects: + +1. Fork the repository +2. Create a feature branch +3. Follow PSR-2 coding standards +4. Write comprehensive tests +5. Submit pull request with detailed description + +## 📝 License + +This project follows Laravel's licensing model. Check the LICENSE file for details. + +--- + +**Created:** August 29, 2025 +**Last Updated:** September 30, 2025 +**Framework:** Laravel PHP Framework ## Code & Repository diff --git a/docs/projects/billing.md b/docs/projects/billing.md index 4be0bb5..b51eb76 100644 --- a/docs/projects/billing.md +++ b/docs/projects/billing.md @@ -1,9 +1,204 @@ -# billing +# Billing Portal - Comprehensive Billing Management System ## Overview -Billing Potal +A comprehensive billing portal system built with PHP and modern web technologies. This robust platform provides complete billing management capabilities including invoice generation, payment tracking, subscription management, and financial reporting for businesses of all sizes. -Billing Potal +## ✨ Key Features + +- **Invoice Management:** Create, send, and track invoices with automated reminders +- **Payment Processing:** Multiple payment gateway integration with real-time processing +- **Subscription Billing:** Recurring billing for subscription-based services +- **Client Management:** Comprehensive client database with billing history +- **Financial Reporting:** Detailed financial reports and analytics dashboards +- **Tax Management:** Automated tax calculation and compliance reporting +- **Multi-currency Support:** Handle international clients with currency conversion +- **Payment Reminders:** Automated email reminders for overdue invoices +- **Receipt Generation:** Professional receipts and billing documentation + +## 🛠️ Technology Stack + +### Primary Technologies +- **Backend:** PHP (68.1%) - Core billing logic and API endpoints +- **Frontend:** JavaScript (27.0%) - Interactive user interface and real-time updates +- **Styling:** CSS (3.6%) - Professional billing portal design +- **Templates:** Blade (1.0%) - Dynamic invoice and report generation +- **Additional:** Hack (0.3%) - Enhanced functionality and optimization + +### Billing System Features +- **Database Integration:** Secure financial data storage and retrieval +- **API Architecture:** RESTful API for third-party integrations +- **Security Framework:** PCI DSS compliant payment processing +- **Notification System:** Email and SMS billing notifications +- **Export Capabilities:** PDF, Excel, and CSV export functionality + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/billing +- **Primary Language:** PHP +- **Languages:** PHP (68.1%), JavaScript (27.0%), CSS (3.6%), Blade (1.0%), Hack (0.3%) +- **Last Updated:** 16/10/2024 +- **Repository Size:** ~234MB + +### Project Status +- **Status:** ✅ Active +- **Visibility:** 🔐 Private +- **Category:** Financial Management System +- **Tags:** #php #billing #invoicing #payment-processing #financial-management #business + +## 🚀 Getting Started + +### Prerequisites +- PHP 8.0 or higher +- MySQL 8.0 or higher for financial data storage +- Composer for dependency management +- Web server with SSL support (required for payments) +- Payment gateway accounts (Stripe, PayPal, etc.) +- SMTP server for email notifications + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/billing.git + cd billing + ``` + +2. **Install dependencies** + ```bash + composer install + npm install + ``` + +3. **Environment setup** + ```bash + cp .env.example .env + # Configure database, payment gateways, and email settings + ``` + +4. **Database configuration** + ```bash + php artisan migrate + php artisan db:seed --class=BillingSeeder + ``` + +5. **Payment gateway setup** + ```bash + # Configure payment processor credentials in .env + # Set up webhook endpoints for payment notifications + ``` + +6. **Run the application** + ```bash + php artisan serve + ``` + +## 💰 Billing Management Features + +### Invoice System +- **Professional Invoices:** Customizable invoice templates with company branding +- **Automated Generation:** Recurring invoice creation for subscription clients +- **Multi-format Export:** PDF, HTML, and print-ready invoice formats +- **Payment Tracking:** Real-time payment status and transaction history +- **Late Fee Management:** Automatic late fee calculation and application + +### Payment Processing +- **Multiple Gateways:** Support for Stripe, PayPal, Square, and other processors +- **Secure Processing:** PCI DSS compliant payment handling +- **Payment Methods:** Credit cards, ACH, bank transfers, and digital wallets +- **Refund Management:** Process refunds and handle payment disputes +- **Payment Analytics:** Track payment success rates and processing metrics + +### Client Management +- **Client Profiles:** Comprehensive client information and billing preferences +- **Billing History:** Complete transaction and payment history per client +- **Credit Management:** Client credit limits and payment terms +- **Communication Log:** Track all client communications and interactions +- **Custom Fields:** Flexible client data fields for specific business needs + +## 📊 Financial Reporting & Analytics + +### Business Intelligence +- **Revenue Reports:** Track revenue trends, growth, and forecasting +- **Aging Reports:** Monitor outstanding invoices and collection metrics +- **Tax Reports:** Automated tax reporting and compliance documentation +- **Profit Analysis:** Detailed profit and loss analysis by client and service +- **Cash Flow:** Cash flow projections and financial planning tools + +### Dashboard Analytics +- **Real-time Overview:** Live financial metrics and key performance indicators +- **Payment Trends:** Analyze payment patterns and client behavior +- **Collection Metrics:** Track collection efficiency and outstanding balances +- **Revenue Forecasting:** Predictive analytics for future revenue planning +- **Custom Reports:** Create tailored reports for specific business needs + +## 🔒 Security & Compliance + +### Financial Security +- **Data Encryption:** End-to-end encryption for all financial data +- **PCI Compliance:** Full PCI DSS compliance for payment processing +- **Access Control:** Role-based access control for financial information +- **Audit Trail:** Comprehensive logging of all financial transactions +- **Backup System:** Automated backup and disaster recovery procedures + +### Regulatory Compliance +- **Tax Compliance:** Automated tax calculation and reporting +- **GDPR Compliance:** Data protection and privacy controls +- **Financial Regulations:** Compliance with financial industry standards +- **SOX Compliance:** Internal controls for financial reporting +- **Industry Standards:** Follow accounting and billing best practices + +## 🔧 Advanced Features + +### Automation Capabilities +- **Recurring Billing:** Automated subscription and recurring payment processing +- **Payment Reminders:** Smart reminder system with escalation workflows +- **Report Scheduling:** Automated report generation and distribution +- **Integration APIs:** Connect with accounting software and CRM systems +- **Webhook Support:** Real-time event notifications for external systems + +### Customization Options +- **Branded Invoices:** Custom invoice templates with company branding +- **Flexible Pricing:** Support for various pricing models and structures +- **Custom Fields:** Add custom data fields for specific business requirements +- **Workflow Customization:** Adapt billing workflows to business processes +- **Multi-language:** Localization support for international operations + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Financial Expertise:** Based on accounting and billing industry standards +- **Security Focus:** PCI DSS compliant development practices + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/billing) +- **User Manual:** Comprehensive billing portal user guide +- **API Documentation:** Integration guide for developers +- **Financial Standards:** Accounting and billing best practices + +## 🤝 Contributing + +Areas for billing system enhancement: + +1. **Mobile Apps:** Native mobile applications for iOS and Android +2. **Advanced Analytics:** Machine learning for payment prediction and risk assessment +3. **Integration Expansion:** More accounting software and CRM integrations +4. **International Features:** Multi-currency and international tax compliance +5. **AI Features:** Intelligent payment reminders and collection optimization + +Contributing guidelines: +- Ensure financial data security and compliance +- Follow PCI DSS requirements for payment processing +- Test thoroughly with real billing scenarios +- Consider international accounting standards +- Implement comprehensive audit logging + +--- + +**Created:** October 16, 2024 +**Last Updated:** September 30, 2025 +**Business Type:** Comprehensive Billing Management Portal ## Code & Repository diff --git a/docs/projects/cbrms.md b/docs/projects/cbrms.md index ee8909f..394220b 100644 --- a/docs/projects/cbrms.md +++ b/docs/projects/cbrms.md @@ -1,11 +1,159 @@ -# CBRMS +# CBRMS - Cheque Bureau Requisition Management System ## Overview -

Laravel Logo

+A comprehensive Cheque Bureau Requisition Management System (CBRMS) built with Laravel framework. This system facilitates efficient management of community resources, member coordination, and administrative oversight for community-driven organizations and local governance. -

-Build Status -Total Downloads +## ✨ Key Features + +- **Resource Management:** Track and manage Cheque requisitions, assets, facilities, and equipment +- **Branch Directory:** Comprehensive branch profiles +- **Reporting System:** Generate templates on requisition and printable data +- **Role-Based Access:** Multi-level user permissions for different community role + +## 🛠️ Technology Stack + +### Primary Technologies +- **Framework:** Laravel (PHP Framework) +- **Backend:** PHP (93.9%) +- **Frontend:** CSS (3.0%), JavaScript (2.4%), Blade (0.3%) +- **Database:** MySQL with Laravel Eloquent ORM +- **Additional:** Hack (0.4%) for enhanced functionality + +### Laravel Architecture +- **MVC Pattern:** Model-View-Controller architecture +- **Eloquent ORM:** Database relationships and migrations +- **Blade Templating:** Dynamic view rendering +- **RESTful APIs:** Clean API structure for data operations +- **Authentication:** Multi-role authentication system + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/CBRMS +- **Primary Language:** PHP +- **Languages:** PHP (93.9%), CSS (3.0%), JavaScript (2.4%), Hack (0.4%), Blade (0.3%) +- **Last Updated:** 26/12/2023 +- **Repository Size:** ~81MB + +### Project Status +- **Status:** ✅ Active +- **Visibility:** 🌐 Public +- **Category:** Community Management System +- **Tags:** #laravel #php #community-management #resource-management #web-application + +## 🚀 Getting Started + +### Prerequisites +- PHP 8.0 or higher +- Composer for dependency management +- MySQL 5.7 or higher +- Web server (Apache/Nginx) +- Node.js and npm for frontend assets + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/CBRMS.git + cd CBRMS + ``` + +2. **Install dependencies** + ```bash + composer install + npm install + ``` + +3. **Environment configuration** + ```bash + cp .env.example .env + php artisan key:generate + ``` + +4. **Database setup** + ```bash + # Configure database credentials in .env + php artisan migrate + php artisan db:seed + ``` + +5. **Compile frontend assets** + ```bash + npm run dev + ``` + +6. **Run the application** + ```bash + php artisan serve + ``` + +## 🏘️ Community Management Features + +### Resource Management +- **Asset Inventory:** Track community equipment, facilities, and resources +- **Booking System:** Schedule and manage resource reservations +- **Maintenance Logs:** Record maintenance activities and schedules +- **Usage Analytics:** Monitor resource utilization patterns + +### Member Management +- **Member Profiles:** Comprehensive member information and contact details +- **Role Assignment:** Define community roles and responsibilities +- **Skill Directory:** Track member skills and expertise for project matching +- **Communication Preferences:** Manage member notification settings + +### Administrative Tools +- **Dashboard Analytics:** Overview of community activities and metrics +- **Financial Management:** Track community funds, expenses, and budgets +- **Event Calendar:** Community event planning and coordination +- **Document Library:** Centralized storage for community documents + +## 👥 User Roles & Permissions + +### Community Roles +- **Administrator:** Full system access and community oversight +- **Coordinator:** Manage events, resources, and member coordination +- **Member:** Access to community resources and participation in activities +- **Guest:** Limited access to public community information + +### Permission System +- **Resource Access:** Role-based resource booking and management +- **Financial Control:** Restricted access to financial data and transactions +- **Administrative Functions:** Limited to authorized community leaders +- **Communication Rights:** Controlled messaging and announcement capabilities + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Community Input:** Based on real community management requirements +- **Framework:** Laravel by Taylor Otwell + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/CBRMS) +- **Laravel Documentation:** [Official Laravel Docs](https://laravel.com/docs) +- **Community Management:** Best practices for community resource coordination + +## 🤝 Contributing + +We welcome contributions to improve community management features: + +1. Fork the repository +2. Create a feature branch for community enhancements +3. Follow Laravel coding standards +4. Test thoroughly with community use cases +5. Submit pull request with detailed description + +Areas for contribution: +- Enhanced reporting features +- Mobile-responsive improvements +- Integration with external community tools +- Advanced analytics and insights + +--- + +**Created:** December 26, 2023 +**Last Updated:** September 30, 2025 +**Focus:** Community Resource Management ## Code & Repository diff --git a/docs/projects/cse482l.md b/docs/projects/cse482l.md index c97d9fc..867e9f3 100644 --- a/docs/projects/cse482l.md +++ b/docs/projects/cse482l.md @@ -1,7 +1,113 @@ -# cse482L +# CSE482L - Internet Programming Laboratory ## Overview -No description +Academic project developed for the CSE482L Internet Programming Laboratory course. This project demonstrates practical application of web development technologies including HTML, CSS, PHP, and JavaScript in building interactive web applications. + +## ✨ Key Features + +- **Web Application Development:** Complete web application with frontend and backend components +- **Database Integration:** PHP-based backend with database connectivity +- **Interactive UI:** Dynamic user interface with JavaScript functionality +- **Responsive Design:** Mobile-friendly layout with CSS styling +- **Form Handling:** Server-side form processing and validation +- **Academic Standards:** Code follows academic best practices and requirements + +## 🛠️ Technology Stack + +### Primary Technologies +- **Frontend:** HTML (89.2%), CSS (5.8%), JavaScript (0.8%) +- **Backend:** PHP (2.2%) +- **Database:** MySQL or similar database system +- **Development:** Hack (1.9%) for additional functionality + +### Academic Focus Areas +- **Internet Programming:** Web development fundamentals +- **Client-Server Architecture:** Understanding of web communication +- **Database Integration:** Server-side data management +- **Web Standards:** HTML5, CSS3, and modern JavaScript practices + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/cse482L +- **Primary Language:** HTML +- **Languages:** HTML (89.2%), CSS (5.8%), PHP (2.2%), Hack (1.9%), JavaScript (0.8%) +- **Last Updated:** 02/03/2022 +- **Repository Size:** ~1MB + +### Project Status +- **Status:** 📦 Archived (Academic Project) +- **Visibility:** 🔐 Private +- **Category:** Academic Project +- **Tags:** #html #css #php #javascript #academic #web-development #cse482l + +## 🚀 Getting Started + +### Prerequisites +- Web server with PHP support (XAMPP, WAMP, or LAMP) +- PHP 7.0 or higher +- MySQL database (if database functionality is included) +- Web browser for testing + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/cse482L.git + cd cse482L + ``` + +2. **Set up web server** + ```bash + # Place files in web server document root + # For XAMPP: htdocs folder + # For WAMP: www folder + ``` + +3. **Database Setup (if applicable)** + ```sql + # Import any provided database schema + # Configure database connections in PHP files + ``` + +4. **Run the application** + ```bash + # Access via web browser + # http://localhost/cse482L + ``` + +## 📚 Academic Context + +### Course Information +- **Course:** CSE482L - Internet Programming Laboratory +- **Academic Level:** Undergraduate Computer Science +- **Learning Objectives:** Web development, client-server programming, database integration +- **Skills Developed:** HTML, CSS, JavaScript, PHP, MySQL + +### Project Scope +This project was developed as part of the Internet Programming Laboratory curriculum, focusing on: +- Understanding web development fundamentals +- Implementing client-server communication +- Database-driven web applications +- Modern web standards and best practices + +## 👥 Contributors + +- **Student Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Course:** CSE482L Internet Programming Laboratory +- **Institution:** Academic institution coursework + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/cse482L) +- **Course Context:** Internet Programming Laboratory project +- **Academic Year:** 2022 + +--- + +**Created:** March 2, 2022 +**Last Updated:** September 30, 2025 +**Academic Project:** CSE482L Internet Programming Laboratory ## Code & Repository diff --git a/docs/projects/desserta.md b/docs/projects/desserta.md index 1826353..1136417 100644 --- a/docs/projects/desserta.md +++ b/docs/projects/desserta.md @@ -1,11 +1,167 @@ -# desserta +# Desserta - Dessert Ordering & Management System ## Overview -

Laravel Logo

+A delicious dessert ordering and management system built with Laravel framework. This web application provides a comprehensive platform for dessert shops to manage their inventory, process customer orders, and deliver sweet experiences through an intuitive online ordering system. -

-Build Status -Total Downloads +## ✨ Key Features + +- **Dessert Catalog:** Beautiful showcase of desserts with images, descriptions, and pricing +- **Online Ordering:** User-friendly ordering system with cart management +- **Inventory Management:** Track dessert availability, ingredients, and stock levels +- **Customer Management:** User accounts, order history, and preferences +- **Order Processing:** Real-time order tracking from placement to delivery +- **Payment Integration:** Secure payment processing for online orders +- **Admin Dashboard:** Comprehensive management tools for shop operations +- **Delivery Tracking:** Real-time order status and delivery updates + +## 🛠️ Technology Stack + +### Primary Technologies +- **Framework:** Laravel (PHP Framework) +- **Frontend:** Blade Templates (55.7%), JavaScript (0.4%) +- **Backend:** PHP (40.4%) +- **Database:** MySQL with Laravel Eloquent ORM +- **Additional:** Hack (3.1%), Shell (0.4%) for deployment scripts + +### Laravel Features +- **Blade Templating:** Rich UI components for dessert showcase +- **Eloquent ORM:** Product catalog and order management +- **Authentication:** Customer and admin login systems +- **RESTful APIs:** Mobile app integration capabilities +- **File Storage:** Image management for dessert photos + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/desserta +- **Primary Language:** Blade +- **Languages:** Blade (55.7%), PHP (40.4%), Hack (3.1%), Shell (0.4%), JavaScript (0.4%) +- **Last Updated:** 23/02/2023 +- **Repository Size:** ~5MB + +### Project Status +- **Status:** ✅ Active +- **Visibility:** 🌐 Public +- **Category:** E-commerce - Food & Beverage +- **Tags:** #laravel #ecommerce #desserts #food-ordering #blade-templates #php + +## 🚀 Getting Started + +### Prerequisites +- PHP 8.0 or higher +- Composer for dependency management +- MySQL 5.7 or higher +- Web server (Apache/Nginx) +- Image optimization tools (for dessert photos) + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/desserta.git + cd desserta + ``` + +2. **Install dependencies** + ```bash + composer install + npm install + ``` + +3. **Environment setup** + ```bash + cp .env.example .env + php artisan key:generate + ``` + +4. **Database configuration** + ```bash + # Configure database credentials in .env + php artisan migrate + php artisan db:seed --class=DessertSeeder + ``` + +5. **Storage setup** + ```bash + php artisan storage:link + ``` + +6. **Run the application** + ```bash + php artisan serve + ``` + +## 🍰 Dessert Shop Features + +### Product Management +- **Dessert Catalog:** Comprehensive dessert listings with categories +- **Image Gallery:** High-quality photos for each dessert item +- **Pricing Management:** Dynamic pricing with discounts and promotions +- **Ingredient Tracking:** Allergen information and dietary restrictions +- **Seasonal Menu:** Special seasonal desserts and limited-time offers + +### Order Management +- **Cart System:** Interactive shopping cart with quantity adjustments +- **Order Customization:** Special instructions and customization options +- **Payment Processing:** Multiple payment method support +- **Order Tracking:** Real-time status updates for customers +- **Delivery Scheduling:** Choose delivery time slots + +### Customer Features +- **User Accounts:** Registration and login for repeat customers +- **Order History:** Track previous orders and reorder favorites +- **Wishlist:** Save favorite desserts for future orders +- **Reviews & Ratings:** Customer feedback system +- **Loyalty Program:** Points and rewards for regular customers + +## 🏪 Business Management + +### Admin Dashboard +- **Sales Analytics:** Revenue tracking and popular item analysis +- **Inventory Control:** Stock management and low-stock alerts +- **Customer Insights:** Order patterns and customer behavior analytics +- **Staff Management:** Employee access and role management +- **Promotion Tools:** Create discounts and marketing campaigns + +### Operational Features +- **Kitchen Display:** Order queue for preparation tracking +- **Delivery Management:** Coordinate delivery routes and timing +- **Supplier Integration:** Manage ingredient suppliers and costs +- **Financial Reports:** Comprehensive business performance reports + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Business Logic:** Dessert shop operational requirements +- **Framework:** Laravel by Taylor Otwell + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/desserta) +- **Laravel Documentation:** [Official Laravel Docs](https://laravel.com/docs) +- **E-commerce Best Practices:** Food ordering system guidelines + +## 🤝 Contributing + +Sweet contributions are welcome! Areas for enhancement: + +1. **Mobile App Integration:** API endpoints for mobile ordering +2. **Advanced Analytics:** Customer behavior and sales forecasting +3. **Multi-location Support:** Chain store management features +4. **Social Features:** Share favorite desserts on social media +5. **AI Recommendations:** Personalized dessert suggestions + +Contributing guidelines: +- Follow Laravel coding standards +- Include tests for new features +- Optimize for food service workflows +- Consider mobile-first design patterns + +--- + +**Created:** February 23, 2023 +**Last Updated:** September 30, 2025 +**Business Type:** Dessert Shop Management System ## Code & Repository diff --git a/docs/projects/digital-product-e-commerce.md b/docs/projects/digital-product-e-commerce.md index d7d4a02..70dc569 100644 --- a/docs/projects/digital-product-e-commerce.md +++ b/docs/projects/digital-product-e-commerce.md @@ -1,11 +1,171 @@ -# digital_product_e-commerce +# Digital Product E-commerce Platform ## Overview -

+A comprehensive digital product e-commerce platform built with Laravel framework. This system specializes in selling digital products such as software, ebooks, courses, and digital media with instant delivery capabilities and secure payment processing. -

-Code Size -Contributors +## ✨ Key Features + +- **Digital Product Catalog:** Comprehensive showcase of digital products with categories and filtering +- **Instant Delivery:** Automated digital product delivery upon successful payment +- **Secure Downloads:** Protected download links with expiration and usage limits +- **User Dashboard:** Customer account management with purchase history +- **Payment Gateway Integration:** Multiple payment options for global customers +- **License Management:** Digital licenses and activation keys for software products +- **Review System:** Customer reviews and ratings for digital products +- **Admin Panel:** Complete e-commerce management with analytics and reporting + +## 🛠️ Technology Stack + +### Primary Technologies +- **Framework:** Laravel (PHP Framework) +- **Backend:** PHP (48.1%) +- **Frontend:** Blade Templates (35.3%), HTML (16.3%) +- **Database:** MySQL with Laravel Eloquent ORM +- **Deployment:** Shell scripts (0.3%) for automation + +### E-commerce Features +- **Shopping Cart:** Advanced cart system for digital products +- **Payment Processing:** Secure payment gateway integration +- **Digital Rights Management:** License validation and protection +- **File Management:** Secure storage and delivery of digital assets +- **SEO Optimization:** Search engine friendly product pages + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/digital_product_e-commerce +- **Primary Language:** PHP +- **Languages:** PHP (48.1%), Blade (35.3%), HTML (16.3%), Shell (0.3%) +- **Stats:** ⭐ 1 stars, 🍴 2 forks +- **Last Updated:** 05/01/2022 +- **Repository Size:** ~5MB + +### Project Status +- **Status:** 📦 Archived +- **Visibility:** 🌐 Public +- **Category:** E-commerce - Digital Products +- **Tags:** #laravel #ecommerce #digital-products #php #blade-templates #online-store + +## 🚀 Getting Started + +### Prerequisites +- PHP 7.4 or higher +- Composer for dependency management +- MySQL 5.7 or higher +- Web server (Apache/Nginx) +- SSL certificate for secure payments +- Storage space for digital product files + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/digital_product_e-commerce.git + cd digital_product_e-commerce + ``` + +2. **Install dependencies** + ```bash + composer install + npm install + ``` + +3. **Environment configuration** + ```bash + cp .env.example .env + php artisan key:generate + ``` + +4. **Database setup** + ```bash + # Configure database and payment gateway credentials in .env + php artisan migrate + php artisan db:seed + ``` + +5. **Storage configuration** + ```bash + php artisan storage:link + # Set up secure file storage for digital products + ``` + +6. **Run the application** + ```bash + php artisan serve + ``` + +## 🛒 E-commerce Features + +### Product Management +- **Digital Catalog:** Organize software, ebooks, courses, and media files +- **Product Variations:** Different versions, licenses, and pricing tiers +- **File Upload System:** Secure upload and management of digital assets +- **Metadata Management:** Product descriptions, tags, and SEO optimization +- **Pricing Strategy:** Flexible pricing with discounts and bundles + +### Customer Experience +- **Browse & Search:** Advanced product discovery with filtering and search +- **Instant Purchase:** Quick checkout process for digital products +- **Account Management:** Customer dashboard with purchase history +- **Download Manager:** Secure download access with usage tracking +- **Customer Support:** Integrated help desk and FAQ system + +### Digital Delivery +- **Automated Delivery:** Instant product delivery after payment confirmation +- **Secure Downloads:** Time-limited and usage-tracked download links +- **License Keys:** Automatic generation and delivery of software licenses +- **Cloud Storage:** Integration with cloud platforms for large file delivery +- **Backup Access:** Customers can re-download purchased products + +## 💳 Payment & Security + +### Payment Processing +- **Multiple Gateways:** Support for various payment providers +- **Global Payments:** International payment method support +- **Recurring Billing:** Subscription-based digital products +- **Fraud Protection:** Advanced fraud detection and prevention +- **Tax Management:** Automatic tax calculation for digital products + +### Security Features +- **File Protection:** Prevent unauthorized access to digital files +- **License Validation:** Anti-piracy measures for software products +- **Secure Authentication:** Multi-factor authentication options +- **Data Encryption:** Protect customer and payment information +- **Regular Backups:** Automated backup system for business continuity + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Community:** 2 forks indicating community interest +- **Framework:** Laravel by Taylor Otwell + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/digital_product_e-commerce) +- **Software Requirements:** Detailed in SRS documentation +- **Laravel Documentation:** [Official Laravel Docs](https://laravel.com/docs) + +## 🤝 Contributing + +Welcome contributions for enhancing digital commerce features: + +1. **Mobile Optimization:** Responsive design improvements +2. **API Development:** RESTful APIs for mobile app integration +3. **Analytics Enhancement:** Advanced sales and customer analytics +4. **Multi-vendor Support:** Marketplace functionality for multiple sellers +5. **Social Integration:** Social media marketing and sharing features + +Contributing guidelines: +- Follow e-commerce security best practices +- Ensure PCI compliance for payment processing +- Test thoroughly with various digital product types +- Consider international market requirements + +--- + +**Created:** January 5, 2022 +**Last Updated:** September 30, 2025 +**Business Focus:** Digital Product E-commerce ## Code & Repository diff --git a/docs/projects/ecourier-courier.md b/docs/projects/ecourier-courier.md index 5551a9d..3bc1aed 100644 --- a/docs/projects/ecourier-courier.md +++ b/docs/projects/ecourier-courier.md @@ -1,11 +1,165 @@ -# ecourier-courier +# eCourier Integration Package ## Overview -Ecourier parcel service php/laravel package +A comprehensive PHP/Laravel package for integrating with eCourier parcel delivery service. This package provides seamless integration with eCourier's API for parcel booking, tracking, and delivery management within Laravel applications. - -

-

Ecourier parcel service php/laravel package

+## ✨ Key Features + +- **Parcel Booking:** Automated parcel booking through eCourier API integration +- **Real-time Tracking:** Live tracking updates for shipped parcels +- **Address Validation:** Verify delivery addresses and service coverage areas +- **Rate Calculator:** Calculate shipping costs based on weight, size, and destination +- **Status Management:** Track parcel status from pickup to delivery +- **API Integration:** Comprehensive eCourier API wrapper for Laravel +- **Documentation:** Complete implementation guide and examples +- **Error Handling:** Robust error handling and logging for API interactions + +## 🛠️ Technology Stack + +### Primary Technologies +- **Framework:** Laravel (PHP Framework) +- **Language:** PHP +- **Integration:** eCourier REST API +- **Architecture:** Service-oriented package architecture + +### Package Features +- **Service Provider:** Laravel service provider for easy integration +- **Configuration:** Configurable API credentials and settings +- **Facades:** Laravel facades for convenient API access +- **Middleware:** Request/response middleware for API optimization +- **Testing:** Comprehensive test suite for API interactions + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/ecourier-courier +- **Primary Language:** PHP +- **Last Updated:** 15/04/2024 +- **Repository Size:** ~0MB +- **Package Type:** Laravel Integration Package + +### Project Status +- **Status:** ✅ Active +- **Visibility:** 🌐 Public +- **Category:** API Integration Package +- **Tags:** #laravel #php #ecourier #delivery #logistics #api-integration #package + +## 🚀 Getting Started + +### Prerequisites +- Laravel 8.0 or higher +- PHP 7.4 or higher +- eCourier merchant account and API credentials +- Composer for package management + +### Installation + +1. **Install via Composer** + ```bash + composer require syed-reza98/ecourier-courier + ``` + +2. **Publish Configuration** + ```bash + php artisan vendor:publish --provider="EcourierCourier\ServiceProvider" + ``` + +3. **Configure API Credentials** + ```bash + # Add to .env file + ECOURIER_API_KEY=your_api_key + ECOURIER_SECRET=your_secret + ECOURIER_USER_ID=your_user_id + ECOURIER_BASE_URL=https://staging.ecourier.com.bd/api/ + ``` + +4. **Usage in Laravel Application** + ```php + use EcourierCourier\Facades\Ecourier; + + // Book a parcel + $response = Ecourier::bookParcel([ + 'recipient_name' => 'John Doe', + 'recipient_mobile' => '01700000000', + 'recipient_address' => 'Dhaka, Bangladesh', + 'product_price' => 1000, + 'payment_method' => 'COD' + ]); + ``` + +## 📦 eCourier Integration Features + +### Parcel Management +- **Book Parcel:** Create new parcel bookings with recipient details +- **Cancel Booking:** Cancel parcels before pickup +- **Bulk Booking:** Process multiple parcel bookings simultaneously +- **Parcel Tracking:** Real-time tracking with status updates +- **Delivery Confirmation:** Automated delivery notifications + +### Service Features +- **Coverage Check:** Verify service availability in delivery areas +- **Price Calculator:** Calculate delivery costs based on parcel details +- **Branch Locator:** Find nearest eCourier branches and pickup points +- **Service Types:** Support for different delivery service types +- **Payment Methods:** COD, prepaid, and other payment options + +### API Endpoints Supported +- **Authentication:** Secure API authentication and token management +- **Parcel Booking:** Complete parcel booking workflow +- **Tracking API:** Real-time parcel status tracking +- **Branch API:** Service area and branch information +- **Payment API:** Payment status and COD management + +## 🏪 Business Integration + +### E-commerce Integration +- **Shopping Cart:** Direct integration with e-commerce platforms +- **Order Fulfillment:** Automated parcel booking for online orders +- **Customer Notifications:** Delivery updates via SMS and email +- **Return Management:** Handle return parcel bookings +- **Analytics:** Delivery performance and customer satisfaction metrics + +### Laravel Application Integration +- **Service Container:** Dependency injection support +- **Event System:** Laravel events for parcel status changes +- **Queue Integration:** Background processing for API calls +- **Cache Support:** Optimize API responses with caching +- **Logging:** Comprehensive logging for debugging and monitoring + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **API Integration:** eCourier official API documentation +- **Framework:** Laravel by Taylor Otwell + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/ecourier-courier) +- **eCourier Official:** [eCourier Bangladesh](https://ecourier.com.bd) +- **Laravel Packages:** [Packagist Registry](https://packagist.org) +- **API Documentation:** eCourier API reference guide + +## 🤝 Contributing + +Contributions welcome for enhancing courier integration: + +1. **API Coverage:** Implement additional eCourier API endpoints +2. **Error Handling:** Improve error handling and user feedback +3. **Testing:** Expand test coverage for various scenarios +4. **Documentation:** Enhance usage examples and guides +5. **Performance:** Optimize API calls and response handling + +Contributing guidelines: +- Follow Laravel package development standards +- Include comprehensive tests for new features +- Update documentation for API changes +- Consider backward compatibility + +--- + +**Created:** April 15, 2024 +**Last Updated:** September 30, 2025 +**Integration Type:** eCourier Delivery Service Package ## Code & Repository diff --git a/docs/projects/lamp-app.md b/docs/projects/lamp-app.md index 74eee23..32b9af6 100644 --- a/docs/projects/lamp-app.md +++ b/docs/projects/lamp-app.md @@ -1,7 +1,112 @@ -# lamp-app +# LAMP Stack Application ## Overview -No description +A modern web application built using the LAMP (Linux, Apache, MySQL, PHP) stack architecture. This project demonstrates full-stack web development with server-side rendering and database integration for dynamic content management. + +## ✨ Key Features + +- **Dynamic Content Management:** Server-side rendering with PHP for dynamic web pages +- **Database Integration:** MySQL database for data persistence and management +- **User Authentication:** Secure user login and registration system +- **Responsive Design:** Mobile-friendly interface with CSS frameworks +- **RESTful Architecture:** Clean API endpoints for data operations +- **Security Features:** Input validation and SQL injection protection + +## 🛠️ Technology Stack + +### Primary Technologies +- **Backend:** PHP (Server-side scripting) +- **Database:** MySQL for data storage +- **Web Server:** Apache HTTP Server +- **Frontend:** HTML, CSS, JavaScript +- **Operating System:** Linux (LAMP stack) + +### Additional Tools & Libraries +- **CSS Framework:** Bootstrap or custom CSS styling +- **JavaScript Libraries:** jQuery for DOM manipulation +- **Security:** PHP security best practices implementation + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/lamp-app +- **Primary Language:** PHP +- **Languages:** PHP (81.0%), CSS (15.8%), Hack (1.7%), JavaScript (1.1%), Shell (0.3%) +- **Last Updated:** 16/07/2025 +- **Repository Size:** ~2MB + +### Project Status +- **Status:** ✅ Active +- **Visibility:** 🌐 Public +- **Category:** Web Development +- **Tags:** #php #mysql #apache #lamp-stack #web-development #fullstack + +## 🚀 Getting Started + +### Prerequisites +- LAMP stack installed (Linux, Apache, MySQL, PHP) +- PHP 7.4 or higher +- MySQL 5.7 or higher +- Apache web server +- Web browser for testing + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/lamp-app.git + cd lamp-app + ``` + +2. **Configure Apache Virtual Host** + ```bash + # Set up virtual host configuration for Apache + # Point document root to the project directory + ``` + +3. **Database Setup** + ```sql + # Create database and import SQL file if available + CREATE DATABASE lamp_app; + USE lamp_app; + # Import any provided SQL schema + ``` + +4. **Configuration** + ```php + # Update database configuration in config files + # Set database credentials and connection parameters + ``` + +5. **Run the application** + ```bash + # Access via web browser + # http://localhost/lamp-app + ``` + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Community Contributors:** Welcome contributions for improvements + +## 🤝 Contributing + +We welcome contributions! Areas for improvement: +- Code optimization and refactoring +- Security enhancements +- UI/UX improvements +- Additional features and functionality + +## 📞 Support & Contact + +- **Issues:** [GitHub Issues](https://github.com/syed-reza98/lamp-app/issues) +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/lamp-app) + +--- + +**Created:** July 16, 2025 +**Last Updated:** September 30, 2025 +**Next Review:** December 2025 ## Code & Repository diff --git a/docs/projects/nsu-ekyc.md b/docs/projects/nsu-ekyc.md index 3da4956..d5f11f6 100644 --- a/docs/projects/nsu-ekyc.md +++ b/docs/projects/nsu-ekyc.md @@ -1,11 +1,180 @@ -# nsu_ekyc +# NSU eKYC - Electronic Know Your Customer System ## Overview -Laravel Project +A comprehensive Electronic Know Your Customer (eKYC) system developed for North South University (NSU). This Laravel-based application streamlines the customer verification process through digital identity verification, document management, and automated compliance checks. -

-Build Status -Total Downloads +## ✨ Key Features + +- **Digital Identity Verification:** Automated identity verification using government databases +- **Document Management:** Secure upload, storage, and verification of identity documents +- **Biometric Integration:** Fingerprint and facial recognition for enhanced security +- **Automated Compliance:** Real-time compliance checks against regulatory requirements +- **Risk Assessment:** AI-powered risk scoring and fraud detection +- **Audit Trail:** Comprehensive logging of all verification activities +- **Mobile Support:** Mobile-responsive design for on-the-go verification +- **API Integration:** RESTful APIs for third-party system integration + +## 🛠️ Technology Stack + +### Primary Technologies +- **Framework:** Laravel (PHP Framework) +- **Backend:** PHP (53.8%) +- **Frontend:** HTML (29.3%), Blade Templates (16.4%) +- **Database:** MySQL with Laravel Eloquent ORM +- **Deployment:** Shell scripts (0.6%) for automation + +### Security Features +- **Encryption:** End-to-end encryption for sensitive data +- **Authentication:** Multi-factor authentication system +- **Authorization:** Role-based access control (RBAC) +- **Data Protection:** GDPR-compliant data handling +- **Secure Storage:** Encrypted document storage system + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/nsu_ekyc +- **Primary Language:** PHP +- **Languages:** PHP (53.8%), HTML (29.3%), Blade (16.4%), Shell (0.6%) +- **Last Updated:** 09/11/2021 +- **Repository Size:** ~3MB + +### Project Status +- **Status:** 📦 Archived +- **Visibility:** 🌐 Public +- **Category:** Identity Verification System +- **Tags:** #laravel #ekyc #identity-verification #compliance #php #security #nsu + +## 🚀 Getting Started + +### Prerequisites +- PHP 7.4 or higher +- Composer for dependency management +- MySQL 5.7 or higher +- Web server with SSL support +- Government API access credentials +- Document scanning capabilities + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/nsu_ekyc.git + cd nsu_ekyc + ``` + +2. **Install dependencies** + ```bash + composer install + npm install + ``` + +3. **Environment setup** + ```bash + cp .env.example .env + php artisan key:generate + ``` + +4. **Database configuration** + ```bash + # Configure database and API credentials in .env + php artisan migrate + php artisan db:seed --class=EkycSeeder + ``` + +5. **Security setup** + ```bash + # Configure SSL certificates and security settings + php artisan passport:install + ``` + +6. **Run the application** + ```bash + php artisan serve + ``` + +## 🔐 eKYC Process Workflow + +### Customer Onboarding +1. **Initial Registration:** Customer provides basic information +2. **Document Upload:** Secure upload of identity documents +3. **Biometric Capture:** Facial recognition and fingerprint scanning +4. **Verification Process:** Automated document and identity verification +5. **Compliance Check:** Regulatory compliance and risk assessment +6. **Final Approval:** Manual review for complex cases + +### Verification Methods +- **Document Verification:** OCR and AI-powered document analysis +- **Database Cross-check:** Verification against government databases +- **Biometric Matching:** Facial recognition and fingerprint matching +- **Address Verification:** Geolocation and address validation +- **Phone Verification:** OTP-based phone number verification + +## 🏛️ Regulatory Compliance + +### Compliance Standards +- **KYC Regulations:** Full compliance with financial KYC requirements +- **Data Protection:** GDPR and local data protection laws +- **Anti-Money Laundering:** AML compliance and suspicious activity detection +- **Financial Regulations:** Adherence to banking and financial regulations +- **Security Standards:** ISO 27001 and other security frameworks + +### NSU Institutional Requirements +- **Student Verification:** Streamlined student identity verification +- **Staff Onboarding:** Automated staff identity verification process +- **Academic Records:** Integration with academic record systems +- **Financial Services:** Support for student financial services +- **Campus Security:** Enhanced campus security through verified identities + +## 📊 Administrative Features + +### Dashboard & Analytics +- **Verification Statistics:** Real-time verification success rates and metrics +- **Risk Analytics:** Risk assessment trends and fraud detection statistics +- **Compliance Reporting:** Automated regulatory compliance reports +- **User Management:** Administrative tools for user and role management +- **System Monitoring:** Real-time system health and performance monitoring + +### Integration Capabilities +- **University Systems:** Integration with NSU student information systems +- **Government APIs:** Connection to national identity verification services +- **Banking Integration:** Support for financial institution requirements +- **Third-party Services:** API endpoints for external system integration + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Institution:** North South University (NSU) +- **Compliance Team:** Regulatory compliance specialists + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/nsu_ekyc) +- **NSU Official:** [North South University](http://www.northsouth.edu) +- **eKYC Standards:** International eKYC compliance guidelines +- **Laravel Documentation:** [Official Laravel Docs](https://laravel.com/docs) + +## 🤝 Contributing + +Areas for enhancement in eKYC systems: + +1. **AI Improvements:** Enhanced machine learning for document verification +2. **Mobile App:** Native mobile applications for better user experience +3. **Blockchain Integration:** Immutable verification records using blockchain +4. **Advanced Biometrics:** Voice recognition and other biometric methods +5. **International Compliance:** Support for multiple country regulations + +Security considerations: +- All contributions must undergo security review +- Follow data protection and privacy guidelines +- Ensure compliance with financial regulations +- Implement comprehensive audit logging + +--- + +**Created:** November 9, 2021 +**Last Updated:** September 30, 2025 +**Institution:** North South University eKYC System ## Code & Repository diff --git a/docs/projects/pos.md b/docs/projects/pos.md index 89e51a7..20281ca 100644 --- a/docs/projects/pos.md +++ b/docs/projects/pos.md @@ -1,11 +1,188 @@ -# pos +# POS - Point of Sale System ## Overview -

Laravel Logo

+A comprehensive Point of Sale (POS) system built with Laravel framework. This robust retail management solution provides complete sales processing, inventory management, customer relationship management, and business analytics for retail businesses of all sizes. -

-Build Status -Total Downloads +## ✨ Key Features + +- **Sales Processing:** Fast and intuitive checkout system with barcode scanning +- **Inventory Management:** Real-time stock tracking with low-stock alerts +- **Customer Management:** Customer profiles, purchase history, and loyalty programs +- **Employee Management:** Staff accounts, permissions, and sales tracking +- **Payment Processing:** Multiple payment methods including cash, card, and digital payments +- **Reporting & Analytics:** Comprehensive sales reports and business insights +- **Multi-location Support:** Manage multiple store locations from single dashboard +- **Offline Mode:** Continue operations during internet connectivity issues + +## 🛠️ Technology Stack + +### Primary Technologies +- **Framework:** Laravel (PHP Framework) +- **Backend:** PHP (61.7%) +- **Frontend:** Blade Templates (32.0%), HTML (5.4%), JavaScript (0.2%) +- **Database:** MySQL with Laravel Eloquent ORM +- **Deployment:** Shell scripts (0.5%) for automation + +### POS-Specific Features +- **Real-time Processing:** Instant transaction processing and receipt generation +- **Hardware Integration:** Barcode scanners, receipt printers, and cash drawers +- **Security:** Secure user authentication and transaction encryption +- **Scalability:** Multi-tenant architecture for franchise operations +- **API Integration:** Payment gateway and accounting software integration + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/pos +- **Primary Language:** PHP +- **Languages:** PHP (61.7%), Blade (32.0%), HTML (5.4%), Shell (0.5%), JavaScript (0.2%) +- **Last Updated:** 14/12/2022 +- **Repository Size:** ~0MB + +### Project Status +- **Status:** ✅ Active +- **Visibility:** 🌐 Public +- **Category:** Retail Management System +- **Tags:** #laravel #pos #retail #inventory #sales #php #point-of-sale #business + +## 🚀 Getting Started + +### Prerequisites +- PHP 8.0 or higher +- Composer for dependency management +- MySQL 5.7 or higher +- Web server (Apache/Nginx) +- POS hardware (barcode scanner, receipt printer, cash drawer) +- SSL certificate for secure transactions + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/pos.git + cd pos + ``` + +2. **Install dependencies** + ```bash + composer install + npm install + ``` + +3. **Environment setup** + ```bash + cp .env.example .env + php artisan key:generate + ``` + +4. **Database configuration** + ```bash + # Configure database credentials in .env + php artisan migrate + php artisan db:seed --class=POSSeeder + ``` + +5. **Hardware configuration** + ```bash + # Configure POS hardware settings in config/pos.php + # Set up receipt printer and barcode scanner drivers + ``` + +6. **Run the application** + ```bash + php artisan serve + ``` + +## 🏪 Retail Management Features + +### Sales & Checkout +- **Product Search:** Fast product lookup by name, SKU, or barcode +- **Shopping Cart:** Interactive cart with quantity adjustments and discounts +- **Payment Processing:** Support for cash, credit/debit cards, and digital wallets +- **Receipt Generation:** Customizable receipt templates with store branding +- **Tax Calculation:** Automated tax calculations with multiple tax rates +- **Discount Management:** Apply discounts, coupons, and promotional offers + +### Inventory Control +- **Stock Management:** Real-time inventory tracking with automatic updates +- **Product Catalog:** Comprehensive product database with categories and variants +- **Supplier Management:** Vendor information and purchase order processing +- **Stock Alerts:** Automatic notifications for low stock and reorder points +- **Barcode Generation:** Generate and print barcodes for new products +- **Inventory Audits:** Regular stock counts and discrepancy reporting + +### Customer Relationship Management +- **Customer Profiles:** Detailed customer information and contact management +- **Purchase History:** Complete transaction history for each customer +- **Loyalty Programs:** Points-based rewards and membership tiers +- **Customer Analytics:** Purchase patterns and behavior analysis +- **Marketing Tools:** Email campaigns and promotional notifications + +## 📊 Business Intelligence & Reporting + +### Sales Analytics +- **Daily Sales Reports:** Comprehensive daily, weekly, and monthly sales summaries +- **Product Performance:** Best-selling products and inventory turnover analysis +- **Employee Performance:** Individual staff sales tracking and commission calculations +- **Profit Margins:** Detailed profit analysis by product and category +- **Customer Analytics:** Customer lifetime value and purchase behavior patterns + +### Financial Management +- **Cash Management:** Daily cash reconciliation and drawer management +- **Payment Reports:** Breakdown of payment methods and transaction types +- **Tax Reporting:** Automated tax report generation for compliance +- **Expense Tracking:** Business expense management and categorization +- **Accounting Integration:** Export data to popular accounting software + +## 🔧 Hardware Integration + +### Supported Hardware +- **Barcode Scanners:** USB and wireless barcode scanner support +- **Receipt Printers:** Thermal and dot-matrix receipt printer compatibility +- **Cash Drawers:** Automatic cash drawer opening and management +- **Customer Displays:** Real-time transaction display for customers +- **Scale Integration:** Digital scale integration for weighted products + +### Multi-location Features +- **Centralized Management:** Manage multiple store locations from one dashboard +- **Inter-store Transfers:** Transfer inventory between store locations +- **Consolidated Reporting:** Combined reports across all locations +- **Remote Monitoring:** Monitor all locations in real-time +- **Franchise Support:** Multi-tenant architecture for franchise operations + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Retail Industry:** Based on real retail business requirements +- **Framework:** Laravel by Taylor Otwell + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/pos) +- **Laravel Documentation:** [Official Laravel Docs](https://laravel.com/docs) +- **POS Best Practices:** Retail industry standards and guidelines + +## 🤝 Contributing + +Welcome contributions for retail system enhancements: + +1. **Mobile POS:** Tablet and mobile device optimization +2. **E-commerce Integration:** Online store synchronization +3. **Advanced Analytics:** Machine learning for sales forecasting +4. **Payment Gateways:** Additional payment method integrations +5. **Cloud Synchronization:** Real-time cloud backup and synchronization + +Contributing guidelines: +- Follow retail industry security standards +- Ensure PCI DSS compliance for payment processing +- Test with real POS hardware configurations +- Consider multi-currency and internationalization support + +--- + +**Created:** December 14, 2022 +**Last Updated:** September 30, 2025 +**Business Type:** Point of Sale Retail System ## Code & Repository diff --git a/docs/projects/saas-ecom.md b/docs/projects/saas-ecom.md index 42beccb..8147642 100644 --- a/docs/projects/saas-ecom.md +++ b/docs/projects/saas-ecom.md @@ -1,11 +1,195 @@ -# saas_ecom +# SaaS E-commerce Backend Platform ## Overview -E-commerce Back-end +A robust Software-as-a-Service (SaaS) e-commerce backend platform built with Laravel framework. This scalable solution provides multi-tenant e-commerce infrastructure, enabling businesses to quickly deploy their online stores with comprehensive backend management capabilities. -

-Build Status -Total Downloads +## ✨ Key Features + +- **Multi-tenant Architecture:** Support multiple e-commerce stores from single installation +- **E-commerce Backend API:** Complete RESTful API for e-commerce operations +- **Store Management:** Individual store configuration and customization +- **Product Catalog Management:** Advanced product management with variants and categories +- **Order Processing System:** Comprehensive order management and fulfillment workflow +- **Payment Gateway Integration:** Multiple payment provider support and processing +- **Inventory Management:** Real-time stock tracking across multiple stores +- **User Management:** Customer and admin user management with role-based access +- **Analytics Dashboard:** Business intelligence and performance metrics + +## 🛠️ Technology Stack + +### Primary Technologies +- **Framework:** Laravel (PHP Framework) +- **Language:** PHP +- **Architecture:** SaaS Multi-tenant REST API +- **Database:** MySQL with tenant isolation + +### SaaS Features +- **Tenant Isolation:** Secure data separation between different stores +- **Scalable Infrastructure:** Horizontal scaling for growing businesses +- **API-First Design:** Headless commerce architecture +- **Cloud Integration:** Cloud storage and CDN support +- **Microservices Ready:** Modular architecture for service separation + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/saas_ecom +- **Primary Language:** PHP +- **Last Updated:** 9/3/2025 +- **Repository Size:** ~5MB + +### Project Status +- **Status:** ✅ Active +- **Visibility:** 🌐 Public +- **Category:** SaaS E-commerce Platform +- **Tags:** #laravel #saas #ecommerce #api #multi-tenant #php #backend #scalable + +## 🚀 Getting Started + +### Prerequisites +- PHP 8.1 or higher +- Composer for dependency management +- MySQL 8.0 or higher (with JSON support) +- Redis for caching and sessions +- Web server with SSL support +- Cloud storage account (AWS S3, Google Cloud, etc.) + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/saas_ecom.git + cd saas_ecom + ``` + +2. **Install dependencies** + ```bash + composer install + npm install + ``` + +3. **Environment configuration** + ```bash + cp .env.example .env + php artisan key:generate + ``` + +4. **Database setup** + ```bash + # Configure database and cloud credentials in .env + php artisan migrate + php artisan db:seed --class=SaasSeeder + ``` + +5. **Multi-tenancy setup** + ```bash + php artisan tenancy:install + php artisan passport:install + ``` + +6. **Run the application** + ```bash + php artisan serve + ``` + +## 🏢 SaaS Architecture Features + +### Multi-tenant Infrastructure +- **Tenant Management:** Create and manage multiple e-commerce stores +- **Domain Mapping:** Custom domain support for each store +- **Resource Isolation:** Secure separation of data and resources +- **Scalable Database Design:** Optimized for multi-tenant performance +- **Billing Integration:** Subscription and usage-based billing system + +### E-commerce API Endpoints +- **Store Management:** CRUD operations for store configuration +- **Product Management:** Product catalog and inventory APIs +- **Order Processing:** Order creation, payment, and fulfillment APIs +- **Customer Management:** User registration, authentication, and profiles +- **Analytics API:** Business metrics and reporting endpoints + +## 💼 Business Management Features + +### Store Administration +- **Store Configuration:** Customize store settings, themes, and branding +- **Payment Setup:** Configure payment gateways and processing fees +- **Shipping Management:** Set up shipping zones, rates, and providers +- **Tax Configuration:** Automated tax calculation and reporting +- **Currency Support:** Multi-currency pricing and conversion + +### Advanced E-commerce Features +- **Product Variants:** Handle size, color, and custom product variations +- **Inventory Tracking:** Real-time stock management with alerts +- **Promotional Tools:** Discounts, coupons, and loyalty programs +- **Advanced Search:** Full-text search with filtering and faceting +- **Recommendation Engine:** AI-powered product recommendations + +## 🔧 Technical Infrastructure + +### Performance & Scalability +- **Caching Strategy:** Redis-based caching for improved performance +- **Database Optimization:** Query optimization and indexing strategies +- **API Rate Limiting:** Protect against abuse with intelligent rate limiting +- **Background Jobs:** Queue-based processing for heavy operations +- **CDN Integration:** Global content delivery for faster loading times + +### Security & Compliance +- **Data Encryption:** End-to-end encryption for sensitive data +- **PCI DSS Compliance:** Secure payment processing standards +- **API Authentication:** JWT-based authentication with refresh tokens +- **GDPR Compliance:** Data protection and privacy controls +- **Security Monitoring:** Real-time security threat detection + +## 📊 Analytics & Reporting + +### Business Intelligence +- **Sales Analytics:** Revenue tracking and trend analysis +- **Customer Insights:** Customer behavior and lifecycle analytics +- **Product Performance:** Best-selling products and inventory turnover +- **Marketing Analytics:** Campaign performance and ROI tracking +- **Financial Reports:** Comprehensive financial reporting and forecasting + +### Real-time Monitoring +- **System Health:** Application performance monitoring +- **API Usage:** Track API calls and performance metrics +- **Error Tracking:** Real-time error monitoring and alerting +- **User Activity:** Customer engagement and usage analytics + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **SaaS Architecture:** Modern multi-tenant design patterns +- **Framework:** Laravel by Taylor Otwell + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/saas_ecom) +- **API Documentation:** Comprehensive API reference guide +- **Laravel Documentation:** [Official Laravel Docs](https://laravel.com/docs) +- **SaaS Best Practices:** Multi-tenant architecture guidelines + +## 🤝 Contributing + +Areas for SaaS platform enhancement: + +1. **Microservices Architecture:** Break down monolith into microservices +2. **Advanced Analytics:** Machine learning for business insights +3. **Mobile SDKs:** Native mobile app development kits +4. **Third-party Integrations:** More payment gateways and services +5. **White-label Solutions:** Complete white-label e-commerce platform + +Contributing guidelines: +- Follow SaaS security best practices +- Ensure tenant data isolation +- Test scalability with multiple tenants +- Consider international compliance requirements +- Implement comprehensive API documentation + +--- + +**Created:** March 9, 2025 +**Last Updated:** September 30, 2025 +**Platform Type:** SaaS Multi-tenant E-commerce Backend ## Code & Repository diff --git a/docs/projects/tms-main.md b/docs/projects/tms-main.md index 4a00ee4..9e68d63 100644 --- a/docs/projects/tms-main.md +++ b/docs/projects/tms-main.md @@ -1,11 +1,209 @@ -# tms-main +# TMS Main - Advanced Task Management System ## Overview -

+An advanced Task Management System (TMS) built with Laravel framework, serving as the main version with enhanced features for enterprise-level task coordination. This comprehensive system provides robust project management, team collaboration, and productivity tracking capabilities for organizations of all sizes. -

-Build Status -Total Downloads +## ✨ Key Features + +- **Advanced Task Management:** Create, assign, and track tasks with dependencies and priorities +- **Project Organization:** Multi-project support with customizable workflows and templates +- **Team Collaboration:** Real-time collaboration tools, comments, and file sharing +- **Time Tracking:** Built-in time tracking with detailed reporting and analysis +- **Kanban Boards:** Visual project management with drag-and-drop functionality +- **Gantt Charts:** Project timeline visualization and critical path analysis +- **Resource Management:** Team member workload balancing and capacity planning +- **Advanced Reporting:** Comprehensive analytics and business intelligence dashboards +- **Mobile Responsive:** Full-featured mobile interface for on-the-go management + +## 🛠️ Technology Stack + +### Primary Technologies +- **Framework:** Laravel (PHP Framework) +- **Backend:** PHP (47.1%) +- **Frontend:** CSS (34.6%), Blade Templates (16.1%), HTML (0.4%) +- **Database:** MySQL with advanced indexing and optimization +- **Additional:** Hack (1.4%) for enhanced functionality + +### Advanced Features +- **Real-time Updates:** WebSocket integration for live collaboration +- **API Integration:** RESTful APIs for third-party service integration +- **File Management:** Secure document storage and version control +- **Notification System:** Multi-channel notifications (email, SMS, in-app) +- **Search Engine:** Full-text search with advanced filtering capabilities + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/tms-main +- **Primary Language:** PHP +- **Languages:** PHP (47.1%), CSS (34.6%), Blade (16.1%), Hack (1.4%), HTML (0.4%) +- **Last Updated:** 11/07/2022 +- **Repository Size:** ~1MB + +### Project Status +- **Status:** ✅ Active +- **Visibility:** 🌐 Public +- **Category:** Enterprise Project Management +- **Tags:** #laravel #task-management #project-management #php #enterprise #collaboration + +## 🚀 Getting Started + +### Prerequisites +- PHP 8.0 or higher +- Composer for dependency management +- MySQL 8.0 or higher +- Redis for caching and real-time features +- Node.js and npm for frontend assets +- Web server with WebSocket support + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/tms-main.git + cd tms-main + ``` + +2. **Install dependencies** + ```bash + composer install + npm install + ``` + +3. **Environment setup** + ```bash + cp .env.example .env + php artisan key:generate + ``` + +4. **Database configuration** + ```bash + # Configure database and Redis credentials in .env + php artisan migrate + php artisan db:seed --class=TMSMainSeeder + ``` + +5. **Real-time features setup** + ```bash + # Configure WebSocket server + php artisan websockets:serve + ``` + +6. **Compile frontend assets** + ```bash + npm run dev + ``` + +7. **Run the application** + ```bash + php artisan serve + ``` + +## 📋 Advanced Project Management + +### Task Management Features +- **Task Hierarchies:** Create parent-child task relationships and dependencies +- **Custom Fields:** Define custom task attributes for specific workflows +- **Task Templates:** Reusable task templates for recurring projects +- **Bulk Operations:** Mass update, assign, and modify multiple tasks +- **Task Automation:** Automated task creation and status updates based on triggers + +### Project Organization +- **Workspace Management:** Organize projects into workspaces and departments +- **Project Templates:** Pre-configured project structures for different industries +- **Milestone Tracking:** Set and monitor important project milestones +- **Budget Management:** Track project budgets, expenses, and profitability +- **Risk Management:** Identify, assess, and mitigate project risks + +### Team Collaboration +- **Real-time Chat:** Built-in messaging system for team communication +- **File Sharing:** Secure document sharing with version control +- **Activity Feeds:** Real-time updates on project and task activities +- **@Mentions:** Tag team members in comments and discussions +- **Team Calendars:** Shared calendars for meetings and deadlines + +## 📊 Analytics & Reporting + +### Performance Analytics +- **Productivity Metrics:** Track team and individual performance indicators +- **Time Analysis:** Detailed time tracking and utilization reports +- **Project Health:** Monitor project progress and identify potential issues +- **Resource Utilization:** Analyze team workload and capacity planning +- **Trend Analysis:** Historical data analysis for continuous improvement + +### Business Intelligence +- **Executive Dashboard:** High-level overview for management and stakeholders +- **Custom Reports:** Create tailored reports for specific business needs +- **Data Export:** Export data to Excel, PDF, and other formats +- **API Analytics:** Track API usage and performance metrics +- **Automated Reporting:** Scheduled report generation and distribution + +## 🔧 Enterprise Features + +### Integration Capabilities +- **Third-party Integrations:** Connect with popular business tools and services +- **API Management:** Comprehensive RESTful API for external integrations +- **Single Sign-On (SSO):** LDAP and SAML authentication support +- **Webhook Support:** Real-time data synchronization with external systems +- **Import/Export Tools:** Bulk data import and export capabilities + +### Security & Compliance +- **Role-based Access Control:** Granular permissions and user management +- **Audit Trail:** Comprehensive logging of all system activities +- **Data Encryption:** End-to-end encryption for sensitive information +- **Backup & Recovery:** Automated backup and disaster recovery procedures +- **Compliance Support:** GDPR, HIPAA, and other regulatory compliance features + +## 🎯 Use Cases & Industries + +### Suitable For +- **Software Development Teams:** Agile project management and sprint planning +- **Marketing Agencies:** Campaign management and client project tracking +- **Construction Companies:** Project scheduling and resource management +- **Consulting Firms:** Client project delivery and time tracking +- **Educational Institutions:** Research project and academic collaboration + +### Workflow Templates +- **Agile/Scrum:** Sprint planning, backlog management, and retrospectives +- **Waterfall:** Traditional project management with sequential phases +- **Kanban:** Continuous flow management with work-in-progress limits +- **Hybrid:** Flexible workflows combining multiple methodologies + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Enterprise Features:** Based on industry best practices and standards +- **Framework:** Laravel by Taylor Otwell + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/tms-main) +- **User Guide:** Comprehensive user documentation and tutorials +- **API Documentation:** Complete API reference for developers +- **Laravel Documentation:** [Official Laravel Docs](https://laravel.com/docs) + +## 🤝 Contributing + +Areas for enhancement in enterprise task management: + +1. **AI Integration:** Machine learning for task prioritization and estimation +2. **Advanced Analytics:** Predictive analytics for project success forecasting +3. **Mobile App:** Native mobile applications for iOS and Android +4. **Voice Integration:** Voice commands and dictation capabilities +5. **Advanced Automation:** Workflow automation with conditional logic + +Contributing guidelines: +- Follow enterprise software development standards +- Ensure scalability for large organizations +- Implement comprehensive security measures +- Consider accessibility and internationalization +- Maintain backward compatibility for upgrades + +--- + +**Created:** July 11, 2022 +**Last Updated:** September 30, 2025 +**Version:** Main Enterprise Edition ## Code & Repository diff --git a/docs/projects/tms.md b/docs/projects/tms.md index 5a33dd7..f94e57d 100644 --- a/docs/projects/tms.md +++ b/docs/projects/tms.md @@ -1,9 +1,87 @@ -# tms +# TMS (Task Management System) ## Overview -# tms +A comprehensive Task Management System built with PHP and Laravel framework. This system provides efficient task tracking, team collaboration, and project management capabilities for small to medium-sized teams. -## Source Code in TMS folder +## ✨ Key Features + +- **Task Creation & Assignment:** Create and assign tasks to team members with priorities and deadlines +- **Project Organization:** Organize tasks into projects and categories for better management +- **Team Collaboration:** Real-time collaboration tools for team communication +- **Progress Tracking:** Monitor task progress and project completion status +- **User Management:** Role-based access control for different user levels +- **Dashboard Analytics:** Visual overview of project progress and team performance + +## 🛠️ Technology Stack + +### Primary Technologies +- **Framework:** Laravel (PHP Framework) +- **Database:** MySQL +- **Frontend:** Blade Templates, CSS, JavaScript +- **Backend:** PHP with Laravel MVC architecture + +### Additional Tools & Libraries +- **Package Manager:** Composer for PHP dependencies +- **Build Tools:** Laravel Mix for asset compilation +- **Authentication:** Laravel's built-in authentication system + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/tms +- **Primary Language:** PHP +- **Languages:** PHP (77.6%), Blade (21.5%), CSS (0.4%), Shell (0.3%), JavaScript (0.2%) +- **Last Updated:** 28/06/2022 +- **Repository Size:** ~0MB + +### Project Status +- **Status:** 📦 Archived +- **Visibility:** 🌐 Public +- **Category:** Web Development +- **Tags:** #php #laravel #task-management #web-application #mvc + +## 🚀 Getting Started + +### Prerequisites +- PHP 7.4 or higher +- Composer +- MySQL or similar database +- Web server (Apache/Nginx) + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/tms.git + cd tms + ``` + +2. **Install dependencies** + ```bash + composer install + ``` + +3. **Environment Setup** + ```bash + cp .env.example .env + # Configure database credentials and other settings + ``` + +4. **Database Migration** + ```bash + php artisan migrate + php artisan db:seed + ``` + +5. **Run the application** + ```bash + php artisan serve + ``` + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Community Contributors:** Open for contributions ## Code & Repository diff --git a/docs/projects/walkinroom-v2-0.md b/docs/projects/walkinroom-v2-0.md index efe0d8d..4dd068a 100644 --- a/docs/projects/walkinroom-v2-0.md +++ b/docs/projects/walkinroom-v2-0.md @@ -1,11 +1,205 @@ -# Walkinroom-v2.0 +# Walkinroom v2.0 - Hotel Management System ## Overview -

+An advanced hotel management system (Version 2.0) built with Laravel framework and modern JavaScript technologies. This comprehensive platform provides complete hotel operations management including room booking, guest services, staff management, and business analytics for hospitality businesses. -

-Build Status -Total Downloads +## ✨ Key Features + +- **Room Reservation System:** Real-time room availability and booking management +- **Guest Management:** Comprehensive guest profiles and service history +- **Check-in/Check-out:** Streamlined front desk operations with digital processes +- **Housekeeping Management:** Room status tracking and maintenance scheduling +- **Billing & Payments:** Integrated billing system with multiple payment options +- **Staff Management:** Employee scheduling, roles, and performance tracking +- **Inventory Management:** Hotel supplies and amenities tracking +- **Reporting Dashboard:** Business intelligence and operational analytics +- **Mobile Responsive:** Full-featured mobile interface for staff and management + +## 🛠️ Technology Stack + +### Primary Technologies +- **Frontend:** JavaScript (63.2%) - Modern ES6+ with interactive features +- **Backend:** PHP (15.6%) with Laravel Framework +- **Templates:** Blade (16.2%) for server-side rendering +- **Styling:** CSS (4.9%) with responsive design +- **Deployment:** Shell scripts (0.1%) for automation + +### Hotel Management Features +- **Real-time Updates:** Live room status and availability updates +- **API Integration:** RESTful APIs for third-party service integration +- **Security Systems:** Role-based access control for different staff levels +- **Multi-language Support:** Internationalization for diverse guests +- **Payment Gateway:** Secure payment processing and PCI compliance + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/Walkinroom-v2.0 +- **Primary Language:** JavaScript +- **Languages:** JavaScript (63.2%), Blade (16.2%), PHP (15.6%), CSS (4.9%), Shell (0.1%) +- **Last Updated:** 28/01/2023 +- **Repository Size:** ~1MB + +### Project Status +- **Status:** ✅ Active +- **Visibility:** 🌐 Public +- **Category:** Hotel Management System +- **Tags:** #laravel #hotel-management #javascript #hospitality #php #booking-system + +## 🚀 Getting Started + +### Prerequisites +- PHP 8.0 or higher +- Node.js 16+ for JavaScript compilation +- Composer for PHP dependencies +- MySQL 8.0 or higher +- Web server with SSL support +- Redis for caching and sessions + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/Walkinroom-v2.0.git + cd Walkinroom-v2.0 + ``` + +2. **Install dependencies** + ```bash + composer install + npm install + ``` + +3. **Environment setup** + ```bash + cp .env.example .env + php artisan key:generate + ``` + +4. **Database configuration** + ```bash + # Configure database credentials in .env + php artisan migrate + php artisan db:seed --class=HotelSeeder + ``` + +5. **Compile frontend assets** + ```bash + npm run dev + # For production + npm run prod + ``` + +6. **Run the application** + ```bash + php artisan serve + ``` + +## 🏨 Hotel Operations Management + +### Front Desk Operations +- **Reservation Management:** Handle bookings, modifications, and cancellations +- **Guest Check-in:** Digital check-in process with ID verification +- **Room Assignment:** Intelligent room assignment based on preferences +- **Guest Services:** Concierge services and special request management +- **Billing Management:** Real-time billing with itemized charges + +### Room Management +- **Room Status Tracking:** Real-time status updates (occupied, clean, maintenance) +- **Housekeeping Coordination:** Task assignment and completion tracking +- **Maintenance Scheduling:** Preventive and corrective maintenance management +- **Room Types & Rates:** Dynamic pricing and room category management +- **Amenity Management:** Track and manage room amenities and supplies + +### Guest Experience +- **Guest Portal:** Online portal for guests to manage their stay +- **Service Requests:** Digital service request system (housekeeping, maintenance) +- **Feedback System:** Guest satisfaction surveys and feedback collection +- **Loyalty Program:** Guest loyalty points and rewards management +- **Communication Hub:** Automated guest communication and notifications + +## 📊 Business Intelligence & Analytics + +### Operational Reports +- **Occupancy Analytics:** Room occupancy rates and trends analysis +- **Revenue Management:** Revenue per available room (RevPAR) tracking +- **Guest Analytics:** Guest demographics and behavior analysis +- **Staff Performance:** Employee productivity and service quality metrics +- **Financial Reports:** Profit and loss statements, cash flow analysis + +### Management Dashboard +- **Real-time Overview:** Live hotel status and key performance indicators +- **Booking Trends:** Reservation patterns and seasonal analysis +- **Competitive Analysis:** Market positioning and rate comparison +- **Forecasting:** Predictive analytics for demand and revenue forecasting +- **Custom Reports:** Tailored reports for specific business needs + +## 🔧 Advanced Features v2.0 + +### Technology Enhancements +- **Modern JavaScript:** Enhanced user interface with real-time updates +- **API-First Design:** Comprehensive REST API for mobile app integration +- **Cloud Integration:** Cloud storage for documents and media files +- **Mobile Optimization:** Progressive web app (PWA) capabilities +- **Performance Optimization:** Caching strategies and database optimization + +### Integration Capabilities +- **Channel Manager:** Connect with booking platforms (Booking.com, Expedia) +- **Payment Gateways:** Multiple payment processor integration +- **Property Management:** Integration with property management systems +- **Accounting Software:** QuickBooks and other accounting system integration +- **Communication Tools:** Email, SMS, and messaging platform integration + +## 🛡️ Security & Compliance + +### Data Security +- **PCI DSS Compliance:** Secure payment card industry standards +- **Data Encryption:** End-to-end encryption for sensitive guest information +- **Access Control:** Multi-level authentication and authorization +- **Audit Trail:** Comprehensive logging of all system activities +- **GDPR Compliance:** European data protection regulation compliance + +### Hotel Industry Standards +- **PMS Integration:** Property Management System compatibility +- **FOSSE Standards:** Front Office System Standards compliance +- **Hospitality Protocols:** Industry-standard check-in/check-out procedures +- **Safety Regulations:** Emergency procedures and safety compliance + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Hospitality Expertise:** Based on hotel industry best practices +- **Technology Stack:** Laravel + Modern JavaScript architecture + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/Walkinroom-v2.0) +- **User Manual:** Comprehensive hotel staff training documentation +- **API Documentation:** Complete API reference for developers +- **Hotel Industry:** Hospitality management best practices + +## 🤝 Contributing + +Areas for hotel management system enhancement: + +1. **Mobile Apps:** Native iOS and Android applications for staff +2. **IoT Integration:** Smart room controls and IoT device management +3. **AI Features:** Predictive analytics and personalization +4. **Voice Integration:** Voice-controlled room services and commands +5. **Blockchain:** Secure guest identity verification using blockchain + +Contributing guidelines: +- Follow hospitality industry standards and compliance +- Ensure data security and guest privacy protection +- Test with real hotel operational workflows +- Consider accessibility for diverse staff and guest needs +- Implement comprehensive error handling and logging + +--- + +**Created:** January 28, 2023 +**Last Updated:** September 30, 2025 +**Version:** 2.0 - Advanced Hotel Management Platform ## Code & Repository diff --git a/docs/projects/walkinroom.md b/docs/projects/walkinroom.md index 31e9e98..0272c3a 100644 --- a/docs/projects/walkinroom.md +++ b/docs/projects/walkinroom.md @@ -1,11 +1,208 @@ -# walkinroom +# Walkinroom - Hotel Booking Website ## Overview -Hotel Website +A comprehensive hotel booking website built with Laravel framework and modern JavaScript technologies. This platform provides a complete hotel reservation system with guest management, room booking, and hospitality service features designed for both hotel staff and guests. -

-Build Status -Total Downloads +## ✨ Key Features + +- **Online Booking System:** Real-time room availability and reservation management +- **Guest Portal:** User-friendly interface for guests to search and book rooms +- **Hotel Management:** Complete back-office management for hotel operations +- **Room Catalog:** Detailed room descriptions with photos and amenities +- **Booking Calendar:** Interactive calendar showing availability and pricing +- **Payment Integration:** Secure payment processing with multiple payment methods +- **Guest Communication:** Automated email confirmations and notifications +- **Review System:** Guest reviews and ratings for service quality improvement +- **Mobile Responsive:** Fully optimized for mobile devices and tablets + +## 🛠️ Technology Stack + +### Primary Technologies +- **Frontend:** JavaScript (63.9%) - Interactive user interface and booking features +- **Backend:** PHP (14.9%) with Laravel Framework +- **Templates:** Blade (16.2%) for dynamic content rendering +- **Styling:** CSS (4.3%) with responsive design principles +- **Additional:** Hack (0.6%) for enhanced functionality + +### Web Features +- **Real-time Availability:** Live room status and booking updates +- **SEO Optimization:** Search engine friendly URLs and meta tags +- **Social Integration:** Social media sharing and login options +- **Multi-language Support:** Internationalization for global guests +- **Analytics Integration:** Google Analytics and booking conversion tracking + +## 📂 Project Information + +### Repository Details +- **GitHub:** https://github.com/syed-reza98/walkinroom +- **Primary Language:** JavaScript +- **Languages:** JavaScript (63.9%), Blade (16.2%), PHP (14.9%), CSS (4.3%), Hack (0.6%) +- **Stats:** ⭐ 2 stars, 🍴 0 forks +- **Last Updated:** 28/01/2023 +- **Repository Size:** ~188MB + +### Project Status +- **Status:** ✅ Active +- **Visibility:** 🌐 Public +- **Category:** Hotel & Hospitality Website +- **Tags:** #laravel #hotel-website #booking-system #javascript #hospitality #php + +## 🚀 Getting Started + +### Prerequisites +- PHP 8.0 or higher +- Node.js 16+ for JavaScript features +- Composer for PHP dependencies +- MySQL 5.7 or higher +- Web server with SSL support (for payments) +- Email service for notifications + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/syed-reza98/walkinroom.git + cd walkinroom + ``` + +2. **Install dependencies** + ```bash + composer install + npm install + ``` + +3. **Environment configuration** + ```bash + cp .env.example .env + php artisan key:generate + ``` + +4. **Database setup** + ```bash + # Configure database credentials in .env + php artisan migrate + php artisan db:seed --class=HotelDataSeeder + ``` + +5. **Frontend assets compilation** + ```bash + npm run dev + # For production deployment + npm run production + ``` + +6. **Run the application** + ```bash + php artisan serve + ``` + +## 🏨 Hotel Website Features + +### Guest Booking Experience +- **Room Search:** Advanced search with filters (dates, guests, room type, price) +- **Room Details:** High-quality photos, amenities, and detailed descriptions +- **Real-time Pricing:** Dynamic pricing based on dates and availability +- **Secure Booking:** SSL-secured booking process with payment protection +- **Booking Management:** Guests can view, modify, or cancel reservations +- **Special Offers:** Promotional rates, packages, and discount codes + +### Hotel Content Management +- **Room Management:** Add, edit, and manage room types and availability +- **Photo Gallery:** Upload and organize hotel and room photos +- **Amenities Management:** Manage hotel facilities and room amenities +- **Content Management:** Update hotel information, policies, and descriptions +- **Pricing Control:** Set seasonal rates, special offers, and pricing rules + +### Reservation Management +- **Booking Dashboard:** Comprehensive view of all reservations and availability +- **Guest Communication:** Automated and manual guest communication tools +- **Payment Processing:** Secure payment handling with refund capabilities +- **Reporting System:** Booking reports, revenue analysis, and occupancy statistics +- **Calendar Overview:** Visual calendar showing bookings and availability + +## 💳 Payment & Booking Features + +### Payment Integration +- **Multiple Payment Methods:** Credit cards, PayPal, and other payment gateways +- **Secure Processing:** PCI DSS compliant payment processing +- **Refund Management:** Handle cancellations and refund processing +- **Currency Support:** Multi-currency pricing and conversion +- **Payment Analytics:** Track payment success rates and revenue metrics + +### Booking Management +- **Reservation Workflow:** Complete booking process from search to confirmation +- **Availability Engine:** Real-time room availability calculation +- **Booking Modifications:** Allow guests to modify or cancel bookings +- **Group Bookings:** Support for multiple rooms and group reservations +- **Waitlist Management:** Handle overbooking and waitlist scenarios + +## 🌐 Marketing & Guest Experience + +### Website Optimization +- **SEO Features:** Optimized for search engines and local search +- **Performance:** Fast loading times and optimized images +- **Mobile First:** Mobile-responsive design for all devices +- **User Experience:** Intuitive navigation and booking flow +- **Accessibility:** WCAG compliant for accessibility standards + +### Guest Services +- **Guest Reviews:** Collect and display guest feedback and ratings +- **FAQ System:** Common questions and automated responses +- **Contact Integration:** Easy contact forms and communication channels +- **Social Proof:** Display testimonials and social media integration +- **Newsletter:** Email marketing and guest communication tools + +## 📊 Analytics & Insights + +### Booking Analytics +- **Conversion Tracking:** Monitor booking conversion rates and optimization +- **Revenue Reports:** Track revenue, average daily rate (ADR), and occupancy +- **Guest Analytics:** Understand guest demographics and booking patterns +- **Seasonal Analysis:** Identify peak seasons and booking trends +- **Performance Metrics:** Website performance and user engagement metrics + +### Business Intelligence +- **Dashboard Overview:** Key performance indicators for hotel management +- **Comparative Analysis:** Year-over-year and month-over-month comparisons +- **Market Insights:** Competitive analysis and market positioning +- **Forecasting:** Predictive analytics for demand forecasting +- **ROI Tracking:** Marketing campaign effectiveness and return on investment + +## 👥 Contributors + +- **Lead Developer:** [Syed Salman Reza](https://github.com/syed-reza98) +- **Community Interest:** 2 stars from GitHub users +- **Hospitality Focus:** Designed for real hotel booking scenarios + +## 📄 Documentation & Links + +- **Repository:** [GitHub Repository](https://github.com/syed-reza98/walkinroom) +- **Demo Site:** Live demonstration of booking features +- **User Guide:** Instructions for hotel staff and administrators +- **API Documentation:** Integration guide for third-party services + +## 🤝 Contributing + +Areas for hotel website enhancement: + +1. **Advanced Features:** Virtual room tours and 360-degree photos +2. **Integration:** Channel manager integration with Booking.com, Expedia +3. **AI Features:** Chatbot for guest inquiries and booking assistance +4. **Mobile App:** Companion mobile app for guests and staff +5. **Analytics:** Advanced booking analytics and revenue management + +Contributing guidelines: +- Focus on user experience and booking conversion optimization +- Ensure security compliance for payment processing +- Test booking workflows thoroughly across different devices +- Consider accessibility and internationalization requirements +- Implement comprehensive SEO best practices + +--- + +**Created:** January 28, 2023 +**Last Updated:** September 30, 2025 +**Business Type:** Hotel Booking Website Platform ## Code & Repository diff --git a/docs/templates/project-documentation-template.md b/docs/templates/project-documentation-template.md new file mode 100644 index 0000000..b20c2ef --- /dev/null +++ b/docs/templates/project-documentation-template.md @@ -0,0 +1,129 @@ +# Project Name + +## Overview + +Brief description of the project (2-3 sentences explaining what the project does and its main purpose). + +## ✨ Key Features + +- **Feature 1:** Description of the main feature +- **Feature 2:** Description of another important feature +- **Feature 3:** Additional feature highlight +- **Feature 4:** More features as needed + +## 🛠️ Technology Stack + +### Primary Technologies +- **Framework/Language:** Main technology used +- **Database:** Database technology (if applicable) +- **Frontend:** Frontend technologies (if applicable) +- **Backend:** Backend technologies (if applicable) + +### Additional Tools & Libraries +- **Dependencies:** Key dependencies and libraries +- **Build Tools:** Build and development tools +- **Deployment:** Deployment platforms and tools + +## 📂 Project Information + +### Repository Details +- **GitHub:** [Repository URL](https://github.com/username/repository) +- **Primary Language:** Main programming language +- **Languages:** Language breakdown with percentages +- **Stats:** ⭐ X stars, 🍴 X forks (if public) +- **Last Updated:** MM/DD/YYYY +- **Repository Size:** ~XMB + +### Project Status +- **Status:** ✅ Active | 🔄 In Development | 🏗️ Under Construction | 📦 Archived | 🚧 Maintenance +- **Visibility:** 🌐 Public | 🔐 Private +- **Live Demo:** [Demo URL](https://demo-link.com) *(if available)* + +### Categories & Tags +- **Category:** Web Development | Mobile App | Desktop Application | Library/Tool | Academic Project | E-commerce | API/Backend | etc. +- **Tags:** #react #nextjs #typescript #ecommerce #saas #api #etc + +## 🚀 Getting Started + +### Prerequisites +- List of required software, versions, and dependencies +- System requirements + +### Installation + +1. **Clone the repository** + ```bash + git clone https://github.com/username/project-name.git + cd project-name + ``` + +2. **Install dependencies** + ```bash + npm install + # or + composer install + # or other package manager + ``` + +3. **Environment Setup** + ```bash + cp .env.example .env + # Configure your environment variables + ``` + +4. **Run the application** + ```bash + npm run dev + # or + php artisan serve + # or appropriate start command + ``` + +## 📸 Screenshots & Demos + +*(Add screenshots, GIFs, or demo videos if available)* + +- **Main Interface:** Description of main UI +- **Key Feature Demo:** Show important functionality +- **Mobile View:** Mobile responsive design *(if applicable)* + +## 👥 Contributors + +- **Lead Developer:** [Name](https://github.com/username) +- **Contributors:** List of other contributors +- **Community Contributors:** Number of community contributors + +## 📄 Documentation & Links + +- **Live Demo:** [Project URL](https://demo-link.com) *(if available)* +- **API Documentation:** [API Docs](https://api-docs-link.com) *(if applicable)* +- **User Guide:** [User Documentation](https://docs-link.com) *(if available)* +- **Contributing Guide:** [Contributing Guidelines](https://github.com/username/project/blob/main/CONTRIBUTING.md) + +## 🤝 Contributing + +We welcome contributions! Please follow these steps: + +1. Fork the repository +2. Create your feature branch (`git checkout -b feature/amazing-feature`) +3. Commit your changes (`git commit -m 'Add some amazing feature'`) +4. Push to the branch (`git push origin feature/amazing-feature`) +5. Open a Pull Request + +For detailed contribution guidelines, see [CONTRIBUTING.md](https://github.com/username/project/blob/main/CONTRIBUTING.md). + +## 📝 License + +This project is licensed under the [License Name] License - see the [LICENSE](https://github.com/username/project/blob/main/LICENSE) file for details. + +## 📞 Support & Contact + +- **Issues:** [GitHub Issues](https://github.com/username/project/issues) +- **Discussions:** [GitHub Discussions](https://github.com/username/project/discussions) +- **Email:** contact@example.com *(if applicable)* + +--- + +**Created:** MM/DD/YYYY +**Last Updated:** MM/DD/YYYY +**Next Review:** MM/DD/YYYY \ No newline at end of file diff --git a/docs/templates/template-usage-guide.md b/docs/templates/template-usage-guide.md new file mode 100644 index 0000000..c7ee34e --- /dev/null +++ b/docs/templates/template-usage-guide.md @@ -0,0 +1,226 @@ +# Project Documentation Template Usage Guide + +## Overview + +This guide explains how to use the standardized project documentation template to create consistent, high-quality project documentation across all CodeStorm Hub projects. + +## Template Sections Explained + +### 1. Project Name +- Use the actual project name as the main heading +- Should match the repository name (converted to readable format) +- Use sentence case with proper capitalization + +### 2. Overview +- **Purpose:** Provide a concise project description +- **Length:** 2-3 sentences maximum +- **Content:** What the project does, its main purpose, and target audience +- **Tone:** Clear, professional, and accessible + +### 3. ✨ Key Features +- **Format:** Use bullet points with descriptive titles +- **Content:** Highlight 4-6 most important features +- **Style:** Use emojis sparingly for visual appeal +- **Description:** Brief explanation for each feature (1 line) + +### 4. 🛠️ Technology Stack +- **Primary Technologies:** Main framework, language, database +- **Additional Tools:** Libraries, build tools, deployment platforms +- **Format:** Use consistent naming (React/Next.js, Laravel, etc.) +- **Organization:** Group related technologies together + +### 5. 📂 Project Information + +#### Repository Details +- **GitHub:** Full repository URL with markdown link +- **Primary Language:** Main programming language from GitHub +- **Languages:** Language breakdown with percentages from GitHub +- **Stats:** Stars and forks (only for public repositories) +- **Last Updated:** Last commit date (MM/DD/YYYY format) +- **Repository Size:** Approximate size from GitHub + +#### Project Status +- **Status Options:** + - ✅ Active: Actively maintained and developed + - 🔄 In Development: Currently being built + - 🏗️ Under Construction: Major changes in progress + - 📦 Archived: No longer maintained + - 🚧 Maintenance: Bug fixes only +- **Visibility:** 🌐 Public or 🔐 Private +- **Live Demo:** Only include if the project has a working demo + +#### Categories & Tags +- **Category:** Primary project type (Web Development, Mobile App, etc.) +- **Tags:** Relevant hashtags for technologies and features +- **Format:** Use lowercase hashtags (#react #typescript) + +### 6. 🚀 Getting Started +- **Prerequisites:** System requirements and dependencies +- **Installation:** Step-by-step setup instructions +- **Commands:** Use proper code blocks with language syntax +- **Environment:** Include environment setup if needed + +### 7. 📸 Screenshots & Demos +- **Optional Section:** Include only if visual content is available +- **Content:** Screenshots, GIFs, or demo videos +- **Format:** Use descriptive captions for accessibility + +### 8. 👥 Contributors +- **Lead Developer:** Project creator/maintainer with GitHub link +- **Contributors:** Key contributors to the project +- **Community:** Mention community contributions if applicable + +### 9. 📄 Documentation & Links +- **Live Demo:** Working application URL +- **API Documentation:** API reference (if applicable) +- **User Guide:** User-facing documentation +- **Contributing:** Link to contribution guidelines + +### 10. 🤝 Contributing +- **Standard Section:** Include standard contribution workflow +- **Customize:** Adjust based on project-specific requirements +- **Links:** Reference project-specific contributing guides + +### 11. 📝 License +- **Include:** License type and link to LICENSE file +- **Standard:** Most projects use MIT or similar open-source licenses + +### 12. 📞 Support & Contact +- **Issues:** Link to GitHub Issues +- **Discussions:** Link to GitHub Discussions (if enabled) +- **Contact:** Project-specific contact information + +## Content Quality Guidelines + +### Writing Standards +- **Tone:** Professional but approachable +- **Language:** Clear, concise, and jargon-free when possible +- **Grammar:** Use proper grammar and spelling +- **Structure:** Follow logical information hierarchy + +### Formatting Rules +- **Headers:** Use proper markdown heading hierarchy (##, ###, ####) +- **Lists:** Use consistent bullet point or numbered list formatting +- **Links:** Use descriptive link text, avoid "click here" +- **Code:** Use appropriate code block syntax highlighting +- **Emphasis:** Use **bold** for important terms, *italic* sparingly + +### Accessibility Considerations +- **Alt Text:** Provide meaningful descriptions for images +- **Headings:** Use proper heading structure for screen readers +- **Links:** Use descriptive link text +- **Color:** Don't rely on color alone to convey information +- **Language:** Use clear, simple language + +## Common Patterns & Standards + +### Repository URLs +```markdown +- **GitHub:** [Repository Name](https://github.com/username/repository) +``` + +### Status Icons & Meanings +- ✅ **Active:** Regular updates, actively maintained +- 🔄 **In Development:** Currently being built, expect changes +- 🏗️ **Under Construction:** Major refactoring or updates in progress +- 📦 **Archived:** No longer actively maintained +- 🚧 **Maintenance:** Bug fixes only, no new features + +### Technology Stack Format +```markdown +### Primary Technologies +- **Framework:** React/Next.js 15+ +- **Language:** TypeScript 5.0+ +- **Database:** PostgreSQL 14+ +- **Styling:** Tailwind CSS 4+ + +### Additional Tools +- **Authentication:** NextAuth.js +- **Payment:** Stripe API +- **Deployment:** Vercel +``` + +### Installation Instructions +```markdown +1. **Clone the repository** + ```bash + git clone https://github.com/username/project.git + cd project + ``` + +2. **Install dependencies** + ```bash + npm install + ``` + +3. **Environment Setup** + ```bash + cp .env.example .env.local + ``` + Configure required environment variables. + +4. **Run the application** + ```bash + npm run dev + ``` +``` + +## Content Removal Guidelines + +### Raw HTML to Remove +- Remove any `

`, `

`, ``, `` tags +- Convert HTML links to markdown format +- Remove inline styling and HTML attributes +- Convert HTML badges to markdown format + +### Placeholder Content to Update +- Replace "No description" with proper project description +- Remove template boilerplate text (like "Laravel Framework") +- Update placeholder social links ("#" values) +- Replace generic repository descriptions + +## Quality Checklist + +Before finalizing any project documentation, ensure: + +- [ ] **Content Completeness** + - [ ] All sections have meaningful content (no "No description") + - [ ] Technology stack is accurate and complete + - [ ] Project status reflects current state + - [ ] Categories and tags are relevant + +- [ ] **Format Consistency** + - [ ] Follows template structure exactly + - [ ] Uses consistent markdown formatting + - [ ] All links are properly formatted + - [ ] Code blocks have proper syntax highlighting + +- [ ] **Information Accuracy** + - [ ] Repository URLs are correct and accessible + - [ ] Live demo links work (if provided) + - [ ] Technology versions are current + - [ ] Contact information is valid + +- [ ] **Accessibility & Readability** + - [ ] Headers follow logical hierarchy + - [ ] Links have descriptive text + - [ ] Content is clear and jargon-free + - [ ] Images have proper alt text (if included) + +## Maintenance Guidelines + +### Regular Updates +- **Monthly:** Review and update "Last Updated" dates +- **Quarterly:** Verify live demo links and repository information +- **As Needed:** Update project status and technology versions + +### Content Reviews +- **New Projects:** Use this template for all new project documentation +- **Existing Projects:** Gradually update to match this standard +- **Community Contributions:** Ensure all contributions follow this template + +--- + +**Created:** September 30, 2025 +**Last Updated:** September 30, 2025 +**Next Review:** October 15, 2025 \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index fb939d7..6757da3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13,6 +13,7 @@ "@radix-ui/react-dropdown-menu": "^2.1.16", "@radix-ui/react-icons": "^1.3.2", "@radix-ui/react-navigation-menu": "^1.2.14", + "@radix-ui/react-separator": "^1.1.7", "@radix-ui/react-slot": "^1.2.3", "@radix-ui/react-toast": "^1.2.15", "class-variance-authority": "^0.7.1", @@ -21,6 +22,7 @@ "next": "15.5.4", "react": "19.1.0", "react-dom": "19.1.0", + "react-markdown": "^10.1.0", "tailwind-merge": "^3.3.1" }, "devDependencies": { @@ -32,7 +34,7 @@ "eslint": "^9", "eslint-config-next": "15.5.4", "tailwindcss": "^4", - "typescript": "^5" + "typescript": "5.9.2" } }, "node_modules/@alloc/quick-lru": { @@ -1483,6 +1485,29 @@ } } }, + "node_modules/@radix-ui/react-separator": { + "version": "1.1.7", + "resolved": "https://registry.npmjs.org/@radix-ui/react-separator/-/react-separator-1.1.7.tgz", + "integrity": "sha512-0HEb8R9E8A+jZjvmFCy/J4xhbXy3TV+9XSnGJ3KvTtjlIUy/YQ/p6UYZvi7YbeoeXdyU9+Y3scizK6hkY37baA==", + "license": "MIT", + "dependencies": { + "@radix-ui/react-primitive": "2.1.3" + }, + "peerDependencies": { + "@types/react": "*", + "@types/react-dom": "*", + "react": "^16.8 || ^17.0 || ^18.0 || ^19.0 || ^19.0.0-rc", + "react-dom": "^16.8 || ^17.0 || ^18.0 || ^19.0 || ^19.0.0-rc" + }, + "peerDependenciesMeta": { + "@types/react": { + "optional": true + }, + "@types/react-dom": { + "optional": true + } + } + }, "node_modules/@radix-ui/react-slot": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/@radix-ui/react-slot/-/react-slot-1.2.3.tgz", @@ -2010,13 +2035,39 @@ "tslib": "^2.4.0" } }, + "node_modules/@types/debug": { + "version": "4.1.12", + "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.12.tgz", + "integrity": "sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ==", + "license": "MIT", + "dependencies": { + "@types/ms": "*" + } + }, "node_modules/@types/estree": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", - "dev": true, "license": "MIT" }, + "node_modules/@types/estree-jsx": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@types/estree-jsx/-/estree-jsx-1.0.5.tgz", + "integrity": "sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSdkuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg==", + "license": "MIT", + "dependencies": { + "@types/estree": "*" + } + }, + "node_modules/@types/hast": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.4.tgz", + "integrity": "sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, "node_modules/@types/json-schema": { "version": "7.0.15", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", @@ -2031,6 +2082,21 @@ "dev": true, "license": "MIT" }, + "node_modules/@types/mdast": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/@types/mdast/-/mdast-4.0.4.tgz", + "integrity": "sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/ms": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@types/ms/-/ms-2.1.0.tgz", + "integrity": "sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==", + "license": "MIT" + }, "node_modules/@types/node": { "version": "20.19.18", "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.18.tgz", @@ -2045,7 +2111,6 @@ "version": "19.1.15", "resolved": "https://registry.npmjs.org/@types/react/-/react-19.1.15.tgz", "integrity": "sha512-+kLxJpaJzXybyDyFXYADyP1cznTO8HSuBpenGlnKOAkH4hyNINiywvXS/tGJhsrGGP/gM185RA3xpjY0Yg4erA==", - "devOptional": true, "license": "MIT", "dependencies": { "csstype": "^3.0.2" @@ -2061,6 +2126,12 @@ "@types/react": "^19.0.0" } }, + "node_modules/@types/unist": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz", + "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==", + "license": "MIT" + }, "node_modules/@typescript-eslint/eslint-plugin": { "version": "8.45.0", "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.45.0.tgz", @@ -2349,6 +2420,12 @@ "url": "https://opencollective.com/typescript-eslint" } }, + "node_modules/@ungap/structured-clone": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.0.tgz", + "integrity": "sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g==", + "license": "ISC" + }, "node_modules/@unrs/resolver-binding-android-arm-eabi": { "version": "1.11.1", "resolved": "https://registry.npmjs.org/@unrs/resolver-binding-android-arm-eabi/-/resolver-binding-android-arm-eabi-1.11.1.tgz", @@ -2926,6 +3003,16 @@ "node": ">= 0.4" } }, + "node_modules/bail": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/bail/-/bail-2.0.2.tgz", + "integrity": "sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", @@ -3037,6 +3124,16 @@ ], "license": "CC-BY-4.0" }, + "node_modules/ccount": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/ccount/-/ccount-2.0.1.tgz", + "integrity": "sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/chalk": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", @@ -3054,6 +3151,46 @@ "url": "https://github.com/chalk/chalk?sponsor=1" } }, + "node_modules/character-entities": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-2.0.2.tgz", + "integrity": "sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-html4": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/character-entities-html4/-/character-entities-html4-2.1.0.tgz", + "integrity": "sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-legacy": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz", + "integrity": "sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-reference-invalid": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/character-reference-invalid/-/character-reference-invalid-2.0.1.tgz", + "integrity": "sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/chownr": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/chownr/-/chownr-3.0.0.tgz", @@ -3111,6 +3248,16 @@ "dev": true, "license": "MIT" }, + "node_modules/comma-separated-tokens": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz", + "integrity": "sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", @@ -3137,7 +3284,6 @@ "version": "3.1.3", "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz", "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==", - "devOptional": true, "license": "MIT" }, "node_modules/damerau-levenshtein": { @@ -3205,7 +3351,6 @@ "version": "4.4.3", "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", - "dev": true, "license": "MIT", "dependencies": { "ms": "^2.1.3" @@ -3219,6 +3364,19 @@ } } }, + "node_modules/decode-named-character-reference": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/decode-named-character-reference/-/decode-named-character-reference-1.2.0.tgz", + "integrity": "sha512-c6fcElNV6ShtZXmsgNgFFV5tVX2PaV4g+MOAkb8eXHvn6sryJBrZa9r0zV6+dtTyoCKxtDy5tyQ5ZwQuidtd+Q==", + "license": "MIT", + "dependencies": { + "character-entities": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/deep-is": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", @@ -3262,6 +3420,15 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/dequal": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", + "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, "node_modules/detect-libc": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.1.1.tgz", @@ -3278,6 +3445,19 @@ "integrity": "sha512-ypdmJU/TbBby2Dxibuv7ZLW3Bs1QEmM7nHjEANfohJLvE0XVujisn1qPJcZxg+qDucsr+bP6fLD1rPS3AhJ7EQ==", "license": "MIT" }, + "node_modules/devlop": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/devlop/-/devlop-1.1.0.tgz", + "integrity": "sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==", + "license": "MIT", + "dependencies": { + "dequal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/doctrine": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", @@ -3946,6 +4126,16 @@ "node": ">=4.0" } }, + "node_modules/estree-util-is-identifier-name": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/estree-util-is-identifier-name/-/estree-util-is-identifier-name-3.0.0.tgz", + "integrity": "sha512-hFtqIDZTIUZ9BXLb8y4pYGyk6+wekIivNVTcmvk8NoOh+VeRn5y6cEHzbURrWbfp1fIqdVipilzj+lfaadNZmg==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/esutils": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", @@ -3956,6 +4146,12 @@ "node": ">=0.10.0" } }, + "node_modules/extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", + "license": "MIT" + }, "node_modules/extend-shallow": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", @@ -4443,6 +4639,56 @@ "node": ">= 0.4" } }, + "node_modules/hast-util-to-jsx-runtime": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/hast-util-to-jsx-runtime/-/hast-util-to-jsx-runtime-2.3.6.tgz", + "integrity": "sha512-zl6s8LwNyo1P9uw+XJGvZtdFF1GdAkOg8ujOw+4Pyb76874fLps4ueHXDhXWdk6YHQ6OgUtinliG7RsYvCbbBg==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "style-to-js": "^1.0.0", + "unist-util-position": "^5.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-whitespace": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-whitespace/-/hast-util-whitespace-3.0.0.tgz", + "integrity": "sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/html-url-attributes": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/html-url-attributes/-/html-url-attributes-3.0.1.tgz", + "integrity": "sha512-ol6UPyBWqsrO6EJySPz2O7ZSr856WDrEzM5zMqp+FJJLGMW35cLYmmZnl0vztAZxRUoNZJFTCohfjuIJ8I4QBQ==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/ignore": { "version": "5.3.2", "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", @@ -4480,6 +4726,12 @@ "node": ">=0.8.19" } }, + "node_modules/inline-style-parser": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/inline-style-parser/-/inline-style-parser-0.2.4.tgz", + "integrity": "sha512-0aO8FkhNZlj/ZIbNi7Lxxr12obT7cL1moPfE4tg1LkX7LlLfC6DeX4l2ZEud1ukP9jNQyNnfzQVqwbwmAATY4Q==", + "license": "MIT" + }, "node_modules/internal-slot": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.1.0.tgz", @@ -4495,6 +4747,30 @@ "node": ">= 0.4" } }, + "node_modules/is-alphabetical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-2.0.1.tgz", + "integrity": "sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-alphanumerical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphanumerical/-/is-alphanumerical-2.0.1.tgz", + "integrity": "sha512-hmbYhX/9MUMF5uh7tOXyK/n0ZvWpad5caBA17GsC6vyuCqaWliRG5K1qS9inmUhEMaOBIW7/whAnSwveW/LtZw==", + "license": "MIT", + "dependencies": { + "is-alphabetical": "^2.0.0", + "is-decimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/is-array-buffer": { "version": "3.0.5", "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.5.tgz", @@ -4640,6 +4916,16 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/is-decimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-decimal/-/is-decimal-2.0.1.tgz", + "integrity": "sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/is-extendable": { "version": "0.1.1", "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", @@ -4708,6 +4994,16 @@ "node": ">=0.10.0" } }, + "node_modules/is-hexadecimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz", + "integrity": "sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/is-map": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/is-map/-/is-map-2.0.3.tgz", @@ -4761,6 +5057,18 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/is-plain-obj": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-4.1.0.tgz", + "integrity": "sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/is-regex": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.2.1.tgz", @@ -5333,6 +5641,16 @@ "dev": true, "license": "MIT" }, + "node_modules/longest-streak": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/longest-streak/-/longest-streak-3.1.0.tgz", + "integrity": "sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/loose-envify": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", @@ -5366,81 +5684,675 @@ "node": ">= 0.4" } }, - "node_modules/merge2": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", - "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", - "dev": true, + "node_modules/mdast-util-from-markdown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/mdast-util-from-markdown/-/mdast-util-from-markdown-2.0.2.tgz", + "integrity": "sha512-uZhTV/8NBuw0WHkPTrCqDOl0zVe1BIng5ZtHoDk49ME1qqcjYmmLmOf0gELgcRMxN4w2iuIeVso5/6QymSrgmA==", "license": "MIT", - "engines": { - "node": ">= 8" + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "mdast-util-to-string": "^4.0.0", + "micromark": "^4.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-decode-string": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-stringify-position": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" } }, - "node_modules/micromatch": { - "version": "4.0.8", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", - "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", - "dev": true, + "node_modules/mdast-util-mdx-expression": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-mdx-expression/-/mdast-util-mdx-expression-2.0.1.tgz", + "integrity": "sha512-J6f+9hUp+ldTZqKRSg7Vw5V6MqjATc+3E4gf3CFNcuZNWD8XdyI6zQ8GqH7f8169MM6P7hMBRDVGnn7oHB9kXQ==", "license": "MIT", "dependencies": { - "braces": "^3.0.3", - "picomatch": "^2.3.1" + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" }, - "engines": { - "node": ">=8.6" + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" } }, - "node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", + "node_modules/mdast-util-mdx-jsx": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/mdast-util-mdx-jsx/-/mdast-util-mdx-jsx-3.2.0.tgz", + "integrity": "sha512-lj/z8v0r6ZtsN/cGNNtemmmfoLAFZnjMbNyLzBafjzikOM+glrjNHPlf6lQDOTccj9n5b0PPihEBbhneMyGs1Q==", + "license": "MIT", "dependencies": { - "brace-expansion": "^1.1.7" + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "devlop": "^1.1.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "parse-entities": "^4.0.0", + "stringify-entities": "^4.0.0", + "unist-util-stringify-position": "^4.0.0", + "vfile-message": "^4.0.0" }, - "engines": { - "node": "*" + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" } }, - "node_modules/minimist": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", - "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", - "dev": true, + "node_modules/mdast-util-mdxjs-esm": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-mdxjs-esm/-/mdast-util-mdxjs-esm-2.0.1.tgz", + "integrity": "sha512-EcmOpxsZ96CvlP03NghtH1EsLtr0n9Tm4lPUJUBccV9RwUOneqSycg19n5HGzCf+10LozMRSObtVr3ee1WoHtg==", "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, "funding": { - "url": "https://github.com/sponsors/ljharb" + "type": "opencollective", + "url": "https://opencollective.com/unified" } }, - "node_modules/minipass": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", - "integrity": "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==", - "dev": true, - "license": "ISC", - "engines": { - "node": ">=16 || 14 >=14.17" + "node_modules/mdast-util-phrasing": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-phrasing/-/mdast-util-phrasing-4.1.0.tgz", + "integrity": "sha512-TqICwyvJJpBwvGAMZjj4J2n0X8QWp21b9l0o7eXyVJ25YNWYbJDVIyD1bZXE6WtV6RmKJVYmQAKWa0zWOABz2w==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" } }, - "node_modules/minizlib": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-3.1.0.tgz", - "integrity": "sha512-KZxYo1BUkWD2TVFLr0MQoM8vUUigWD3LlD83a/75BqC+4qE0Hb1Vo5v1FgcfaNXvfXzr+5EhQ6ing/CaBijTlw==", - "dev": true, + "node_modules/mdast-util-to-hast": { + "version": "13.2.0", + "resolved": "https://registry.npmjs.org/mdast-util-to-hast/-/mdast-util-to-hast-13.2.0.tgz", + "integrity": "sha512-QGYKEuUsYT9ykKBCMOEDLsU5JRObWQusAolFMeko/tYPufNkRffBAQjIE+99jbA87xv6FgmjLtwjh9wBWajwAA==", "license": "MIT", "dependencies": { - "minipass": "^7.1.2" + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "@ungap/structured-clone": "^1.0.0", + "devlop": "^1.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "trim-lines": "^3.0.0", + "unist-util-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0" }, - "engines": { - "node": ">= 18" + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" } }, - "node_modules/ms": { + "node_modules/mdast-util-to-markdown": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/mdast-util-to-markdown/-/mdast-util-to-markdown-2.1.2.tgz", + "integrity": "sha512-xj68wMTvGXVOKonmog6LwyJKrYXZPvlwabaryTjLh9LuvovB/KAH+kvi8Gjj+7rJjsFi23nkUxRQv1KqSroMqA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "longest-streak": "^3.0.0", + "mdast-util-phrasing": "^4.0.0", + "mdast-util-to-string": "^4.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-decode-string": "^2.0.0", + "unist-util-visit": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-to-string/-/mdast-util-to-string-4.0.0.tgz", + "integrity": "sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/micromark": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.2.tgz", + "integrity": "sha512-zpe98Q6kvavpCr1NPVSCMebCKfD7CA2NqZ+rykeNhONIJBpc1tFKt9hucLGwha3jNTNI8lHpctWJWoimVF4PfA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/debug": "^4.0.0", + "debug": "^4.0.0", + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-core-commonmark/-/micromark-core-commonmark-2.0.3.tgz", + "integrity": "sha512-RDBrHEMSxVFLg6xvnXmb1Ayr2WzLAWjeSATAoxwKYJV94TeNavgoIdA0a9ytzDSVzBy2YKFK+emCPOEibLeCrg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-destination": "^2.0.0", + "micromark-factory-label": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-title": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-html-tag-name": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-destination": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-destination/-/micromark-factory-destination-2.0.1.tgz", + "integrity": "sha512-Xe6rDdJlkmbFRExpTOmRj9N3MaWmbAgdpSrBQvCFqhezUn4AHqJHbaEnfbVYYiexVSs//tqOdY/DxhjdCiJnIA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-label": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-label/-/micromark-factory-label-2.0.1.tgz", + "integrity": "sha512-VFMekyQExqIW7xIChcXn4ok29YE3rnuyveW3wZQWWqF4Nv9Wk5rgJ99KzPvHjkmPXF93FXIbBp6YdW3t71/7Vg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-title": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-title/-/micromark-factory-title-2.0.1.tgz", + "integrity": "sha512-5bZ+3CjhAd9eChYTHsjy6TGxpOFSKgKKJPJxr293jTbfry2KDoWkhBb6TcPVB4NmzaPhMs1Frm9AZH7OD4Cjzw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-whitespace": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-whitespace/-/micromark-factory-whitespace-2.0.1.tgz", + "integrity": "sha512-Ob0nuZ3PKt/n0hORHyvoD9uZhr+Za8sFoP+OnMcnWK5lngSzALgQYKMr9RJVOWLqQYuyn6ulqGWSXdwf6F80lQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-chunked": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-chunked/-/micromark-util-chunked-2.0.1.tgz", + "integrity": "sha512-QUNFEOPELfmvv+4xiNg2sRYeS/P84pTW0TCgP5zc9FpXetHY0ab7SxKyAQCNCc1eK0459uoLI1y5oO5Vc1dbhA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-classify-character": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-classify-character/-/micromark-util-classify-character-2.0.1.tgz", + "integrity": "sha512-K0kHzM6afW/MbeWYWLjoHQv1sgg2Q9EccHEDzSkxiP/EaagNzCm7T/WMKZ3rjMbvIpvBiZgwR3dKMygtA4mG1Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-combine-extensions": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-combine-extensions/-/micromark-util-combine-extensions-2.0.1.tgz", + "integrity": "sha512-OnAnH8Ujmy59JcyZw8JSbK9cGpdVY44NKgSM7E9Eh7DiLS2E9RNQf0dONaGDzEG9yjEl5hcqeIsj4hfRkLH/Bg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-chunked": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-numeric-character-reference": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-2.0.2.tgz", + "integrity": "sha512-ccUbYk6CwVdkmCQMyr64dXz42EfHGkPQlBj5p7YVGzq8I7CtjXZJrubAYezf7Rp+bjPseiROqe7G6foFd+lEuw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-string": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-decode-string/-/micromark-util-decode-string-2.0.1.tgz", + "integrity": "sha512-nDV/77Fj6eH1ynwscYTOsbK7rR//Uj0bZXBwJZRfaLEJ1iGBR6kIfNmlNqaqJf649EP0F3NWNdeJi03elllNUQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "decode-named-character-reference": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-encode": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.1.tgz", + "integrity": "sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-html-tag-name": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-html-tag-name/-/micromark-util-html-tag-name-2.0.1.tgz", + "integrity": "sha512-2cNEiYDhCWKI+Gs9T0Tiysk136SnR13hhO8yW6BGNyhOC4qYFnwF1nKfD3HFAIXA5c45RrIG1ub11GiXeYd1xA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-normalize-identifier": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-2.0.1.tgz", + "integrity": "sha512-sxPqmo70LyARJs0w2UclACPUUEqltCkJ6PhKdMIDuJ3gSf/Q+/GIe3WKl0Ijb/GyH9lOpUkRAO2wp0GVkLvS9Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-resolve-all": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-resolve-all/-/micromark-util-resolve-all-2.0.1.tgz", + "integrity": "sha512-VdQyxFWFT2/FGJgwQnJYbe1jjQoNTS4RjglmSjTUlpUMa95Htx9NHeYW4rGDJzbjvCsl9eLjMQwGeElsqmzcHg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-sanitize-uri": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.1.tgz", + "integrity": "sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-subtokenize": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-subtokenize/-/micromark-util-subtokenize-2.1.0.tgz", + "integrity": "sha512-XQLu552iSctvnEcgXw6+Sx75GflAPNED1qx7eBJ+wydBb2KCbRZe+NwvIEEMM83uml1+2WSXpBAcp9IUCgCYWA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-types": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.2.tgz", + "integrity": "sha512-Yw0ECSpJoViF1qTU4DC6NwtC4aWGt1EkzaQB8KPPyCRR8z9TWeV0HbEFGTO+ZY1wB22zmxnJqhPyTpOVCpeHTA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "dev": true, + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minimist": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/minipass": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", + "integrity": "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=16 || 14 >=14.17" + } + }, + "node_modules/minizlib": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-3.1.0.tgz", + "integrity": "sha512-KZxYo1BUkWD2TVFLr0MQoM8vUUigWD3LlD83a/75BqC+4qE0Hb1Vo5v1FgcfaNXvfXzr+5EhQ6ing/CaBijTlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "minipass": "^7.1.2" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/ms": { "version": "2.1.3", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", - "dev": true, "license": "MIT" }, "node_modules/nanoid": { @@ -5768,6 +6680,31 @@ "node": ">=6" } }, + "node_modules/parse-entities": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/parse-entities/-/parse-entities-4.0.2.tgz", + "integrity": "sha512-GG2AQYWoLgL877gQIKeRPGO1xF9+eG1ujIb5soS5gPvLQ1y2o8FL90w2QWNdf9I361Mpp7726c+lj3U0qK1uGw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^2.0.0", + "character-entities-legacy": "^3.0.0", + "character-reference-invalid": "^2.0.0", + "decode-named-character-reference": "^1.0.0", + "is-alphanumerical": "^2.0.0", + "is-decimal": "^2.0.0", + "is-hexadecimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/parse-entities/node_modules/@types/unist": { + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.11.tgz", + "integrity": "sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA==", + "license": "MIT" + }, "node_modules/path-exists": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", @@ -5875,6 +6812,16 @@ "react-is": "^16.13.1" } }, + "node_modules/property-information": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/property-information/-/property-information-7.1.0.tgz", + "integrity": "sha512-TwEZ+X+yCJmYfL7TPUOcvBZ4QfoT5YenQiJuX//0th53DE6w0xxLEtfK3iyryQFddXuvkIk51EEgrJQ0WJkOmQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/punycode": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", @@ -5934,6 +6881,33 @@ "dev": true, "license": "MIT" }, + "node_modules/react-markdown": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/react-markdown/-/react-markdown-10.1.0.tgz", + "integrity": "sha512-qKxVopLT/TyA6BX3Ue5NwabOsAzm0Q7kAPwq6L+wWDwisYs7R8vZ0nRXqq6rkueboxpkjvLGU9fWifiX/ZZFxQ==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "hast-util-to-jsx-runtime": "^2.0.0", + "html-url-attributes": "^3.0.0", + "mdast-util-to-hast": "^13.0.0", + "remark-parse": "^11.0.0", + "remark-rehype": "^11.0.0", + "unified": "^11.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + }, + "peerDependencies": { + "@types/react": ">=18", + "react": ">=18" + } + }, "node_modules/react-remove-scroll": { "version": "2.7.1", "resolved": "https://registry.npmjs.org/react-remove-scroll/-/react-remove-scroll-2.7.1.tgz", @@ -6047,6 +7021,39 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/remark-parse": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/remark-parse/-/remark-parse-11.0.0.tgz", + "integrity": "sha512-FCxlKLNGknS5ba/1lmpYijMUzX2esxW5xQqjWxw2eHFfS2MSdaHVINFmhjo+qN1WhZhNimq0dZATN9pH0IDrpA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-from-markdown": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-rehype": { + "version": "11.1.2", + "resolved": "https://registry.npmjs.org/remark-rehype/-/remark-rehype-11.1.2.tgz", + "integrity": "sha512-Dh7l57ianaEoIpzbp0PC9UKAdCSVklD8E5Rpw7ETfbTl3FqcOOgq5q2LVDhgGCkaBv7p24JXikPdvhhmHvKMsw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "mdast-util-to-hast": "^13.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/resolve": { "version": "1.22.10", "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.10.tgz", @@ -6410,6 +7417,16 @@ "node": ">=0.10.0" } }, + "node_modules/space-separated-tokens": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz", + "integrity": "sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", @@ -6550,6 +7567,20 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/stringify-entities": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/stringify-entities/-/stringify-entities-4.0.4.tgz", + "integrity": "sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==", + "license": "MIT", + "dependencies": { + "character-entities-html4": "^2.0.0", + "character-entities-legacy": "^3.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/strip-bom": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", @@ -6582,6 +7613,24 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/style-to-js": { + "version": "1.1.17", + "resolved": "https://registry.npmjs.org/style-to-js/-/style-to-js-1.1.17.tgz", + "integrity": "sha512-xQcBGDxJb6jjFCTzvQtfiPn6YvvP2O8U1MDIPNfJQlWMYfktPy+iGsHE7cssjs7y84d9fQaK4UF3RIJaAHSoYA==", + "license": "MIT", + "dependencies": { + "style-to-object": "1.0.9" + } + }, + "node_modules/style-to-object": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/style-to-object/-/style-to-object-1.0.9.tgz", + "integrity": "sha512-G4qppLgKu/k6FwRpHiGiKPaPTFcG3g4wNVX/Qsfu+RqQM30E7Tyu/TEgxcL9PNLF5pdRLwQdE3YKKf+KF2Dzlw==", + "license": "MIT", + "dependencies": { + "inline-style-parser": "0.2.4" + } + }, "node_modules/styled-jsx": { "version": "5.1.6", "resolved": "https://registry.npmjs.org/styled-jsx/-/styled-jsx-5.1.6.tgz", @@ -6740,6 +7789,26 @@ "node": ">=8.0" } }, + "node_modules/trim-lines": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/trim-lines/-/trim-lines-3.0.1.tgz", + "integrity": "sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/trough": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/trough/-/trough-2.2.0.tgz", + "integrity": "sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/ts-api-utils": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.1.0.tgz", @@ -6903,6 +7972,93 @@ "dev": true, "license": "MIT" }, + "node_modules/unified": { + "version": "11.0.5", + "resolved": "https://registry.npmjs.org/unified/-/unified-11.0.5.tgz", + "integrity": "sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "bail": "^2.0.0", + "devlop": "^1.0.0", + "extend": "^3.0.0", + "is-plain-obj": "^4.0.0", + "trough": "^2.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-is": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-6.0.0.tgz", + "integrity": "sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-position": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-position/-/unist-util-position-5.0.0.tgz", + "integrity": "sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-stringify-position": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz", + "integrity": "sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-5.0.0.tgz", + "integrity": "sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit-parents": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-6.0.1.tgz", + "integrity": "sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/unrs-resolver": { "version": "1.11.1", "resolved": "https://registry.npmjs.org/unrs-resolver/-/unrs-resolver-1.11.1.tgz", @@ -6991,6 +8147,34 @@ } } }, + "node_modules/vfile": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/vfile/-/vfile-6.0.3.tgz", + "integrity": "sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vfile-message": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/vfile-message/-/vfile-message-4.0.3.tgz", + "integrity": "sha512-QTHzsGd1EhbZs4AsQ20JX1rC3cOlt/IWJruk893DfLRr57lcnOeMaWG4K0JrRta4mIJZKth2Au3mM3u03/JWKw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-stringify-position": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/which": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", @@ -7128,6 +8312,16 @@ "funding": { "url": "https://github.com/sponsors/sindresorhus" } + }, + "node_modules/zwitch": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/zwitch/-/zwitch-2.0.4.tgz", + "integrity": "sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } } } } diff --git a/package.json b/package.json index f0c1ff3..c79ab1a 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,7 @@ "@radix-ui/react-dropdown-menu": "^2.1.16", "@radix-ui/react-icons": "^1.3.2", "@radix-ui/react-navigation-menu": "^1.2.14", + "@radix-ui/react-separator": "^1.1.7", "@radix-ui/react-slot": "^1.2.3", "@radix-ui/react-toast": "^1.2.15", "class-variance-authority": "^0.7.1", @@ -24,6 +25,7 @@ "next": "15.5.4", "react": "19.1.0", "react-dom": "19.1.0", + "react-markdown": "^10.1.0", "tailwind-merge": "^3.3.1" }, "devDependencies": { @@ -35,6 +37,6 @@ "eslint": "^9", "eslint-config-next": "15.5.4", "tailwindcss": "^4", - "typescript": "^5" + "typescript": "5.9.2" } } diff --git a/src/app/projects/[slug]/page.tsx b/src/app/projects/[slug]/page.tsx new file mode 100644 index 0000000..5b51ac6 --- /dev/null +++ b/src/app/projects/[slug]/page.tsx @@ -0,0 +1,326 @@ +import Link from "next/link" +import { Container } from "@/components/ui/container" +import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@/components/ui/card" +import { Button } from "@/components/ui/button" +import { Badge } from "@/components/ui/badge" +import { Separator } from "@/components/ui/separator" +import { GitHubLogoIcon, ExternalLinkIcon, StarIcon, CopyIcon, CalendarIcon, PersonIcon, CheckCircledIcon, ArchiveIcon, UpdateIcon, ReloadIcon, ComponentInstanceIcon, GlobeIcon, LockClosedIcon, StarFilledIcon } from "@radix-ui/react-icons" +import { getAllProjects, getProjectBySlug } from "@/lib/project-data" +import { notFound } from "next/navigation" +import ReactMarkdown from "react-markdown" + +interface ProjectPageProps { + params: Promise<{ + slug: string + }> +} + +export async function generateStaticParams() { + const projects = getAllProjects() + return projects.map((project) => ({ + slug: project.slug, + })) +} + +export async function generateMetadata({ params }: ProjectPageProps) { + const { slug } = await params + const project = getProjectBySlug(slug) + + if (!project) { + return { + title: "Project Not Found", + } + } + + return { + title: `${project.name} | CodeStorm Hub Projects`, + description: project.overview || project.description || `Learn more about ${project.name} - an innovative project by CodeStorm Hub.`, + openGraph: { + title: project.name, + description: project.overview || project.description, + type: "website", + }, + } +} + +export default async function ProjectPage({ params }: ProjectPageProps) { + const { slug } = await params + const project = getProjectBySlug(slug) + + if (!project) { + notFound() + } + + const getStatusBadge = (status: string | undefined) => { + const statusConfig = { + 'Active': { icon: CheckCircledIcon, color: 'bg-green-100 text-green-800 border-green-200' }, + 'Archived': { icon: ArchiveIcon, color: 'bg-gray-100 text-gray-800 border-gray-200' }, + 'Maintenance': { icon: UpdateIcon, color: 'bg-yellow-100 text-yellow-800 border-yellow-200' }, + 'In Development': { icon: ReloadIcon, color: 'bg-blue-100 text-blue-800 border-blue-200' }, + 'Under Construction': { icon: ComponentInstanceIcon, color: 'bg-orange-100 text-orange-800 border-orange-200' }, + } + const config = statusConfig[status as keyof typeof statusConfig] || statusConfig['Active'] + const Icon = config.icon + return ( + + + {status} + + ) + } + + const getTechBadgeColor = (tech: string) => { + const colors: Record = { + 'JavaScript': 'bg-yellow-100 text-yellow-800 border-yellow-200', + 'TypeScript': 'bg-blue-100 text-blue-800 border-blue-200', + 'Python': 'bg-green-100 text-green-800 border-green-200', + 'PHP': 'bg-purple-100 text-purple-800 border-purple-200', + 'Laravel': 'bg-red-100 text-red-800 border-red-200', + 'Vue.js': 'bg-emerald-100 text-emerald-800 border-emerald-200', + 'React': 'bg-cyan-100 text-cyan-800 border-cyan-200', + 'Next.js': 'bg-gray-100 text-gray-800 border-gray-200', + 'HTML': 'bg-orange-100 text-orange-800 border-orange-200', + 'CSS': 'bg-pink-100 text-pink-800 border-pink-200', + } + return colors[tech] || 'bg-secondary text-secondary-foreground border-border' + } + + return ( +
+ +
+ {/* Breadcrumb */} + + + {/* Project Header */} +
+
+
+
+

{project.name}

+ {project.primaryLanguage && ( + + {project.primaryLanguage} + + )} +
+ +
+ {getStatusBadge(project.status)} + {project.category && ( + + {project.category} + + )} + {project.visibility && ( + + {project.visibility === 'Public' ? ( + + ) : ( + + )} + {project.visibility} + + )} +
+ +

+ {project.overview || project.description || 'An innovative project demonstrating modern development practices and solving real-world challenges.'} +

+
+ + {/* Action Buttons */} +
+
+ + {/* Project Stats */} + {project.github && ( +
+ {project.stars !== undefined && ( +
+ + {project.stars.toLocaleString()} + stars +
+ )} + {project.forks !== undefined && ( +
+ + {project.forks} + forks +
+ )} + {project.lastUpdated && ( +
+ + Updated {project.lastUpdated} +
+ )} +
+ )} +
+ + + +
+ {/* Main Content */} +
+ {/* Key Features */} + {project.keyFeatures && project.keyFeatures.length > 0 && ( + + + + + Key Features + + + +
    + {project.keyFeatures.map((feature, idx) => { + const [title, description] = feature.split(': ') + return ( +
  • + +
    + {title}: + {description} +
    +
  • + ) + })} +
+
+
+ )} + + {/* Full Documentation */} + + + 📋 Complete Documentation + + Comprehensive project documentation including setup, usage, and contribution guidelines. + + + +
+ {project.content} +
+
+
+
+ + {/* Sidebar */} +
+ {/* Technology Stack */} + {project.techStack && project.techStack.length > 0 && ( + + + 🛠️ Technology Stack + + +
+ {project.techStack.map((tech, idx) => ( + + {tech} + + ))} +
+
+
+ )} + + {/* Project Details */} + + + 📋 Project Details + + + {project.architecture && ( +
+ Architecture: +

{project.architecture}

+
+ )} + {project.repositorySize && ( +
+ Repository Size: +

{project.repositorySize}

+
+ )} + {project.languages && project.languages.length > 0 && ( +
+ Languages: +

{project.languages.join(', ')}

+
+ )} +
+
+ + {/* Contributors */} + {project.contributors && project.contributors.length > 0 && ( + + + 👥 Contributors + + +
+ {project.contributors.map((contributor, idx) => ( +
+ + {contributor} +
+ ))} +
+
+
+ )} + + {/* Tags */} + {project.tags && project.tags.length > 0 && ( + + + 🏷️ Tags + + +
+ {project.tags.map((tag, idx) => ( + + #{tag} + + ))} +
+
+
+ )} +
+
+
+ +
+ ) +} \ No newline at end of file diff --git a/src/app/projects/page.tsx b/src/app/projects/page.tsx index 4d3e4b7..10ee7c5 100644 --- a/src/app/projects/page.tsx +++ b/src/app/projects/page.tsx @@ -1,124 +1,210 @@ +import Link from "next/link" import { Container } from "@/components/ui/container" import { Card, CardContent, CardDescription, CardHeader, CardTitle, CardFooter } from "@/components/ui/card" import { Button } from "@/components/ui/button" -import { GitHubLogoIcon, ExternalLinkIcon, StarIcon, CopyIcon } from "@radix-ui/react-icons" -import { getAllProjects, getFeaturedProjects } from "@/lib/project-data" +import { Badge } from "@/components/ui/badge" +import { Separator } from "@/components/ui/separator" +import { GitHubLogoIcon, ExternalLinkIcon, StarIcon, CopyIcon, CalendarIcon, CheckCircledIcon, ArchiveIcon, UpdateIcon, ReloadIcon, ComponentInstanceIcon, GlobeIcon, LockClosedIcon } from "@radix-ui/react-icons" +import { getAllProjects, getFeaturedProjects, getAllCategories } from "@/lib/project-data" export const metadata = { title: "Projects", - description: "Explore our open-source projects and contributions to the community.", + description: "Explore our comprehensive collection of open-source projects and contributions to the community.", } export default function ProjectsPage() { const allProjects = getAllProjects() - const featuredProjects = getFeaturedProjects(3) + const featuredProjects = getFeaturedProjects(6) + const categories = getAllCategories() const otherProjects = allProjects.filter(p => !featuredProjects.some(fp => fp.slug === p.slug)) + const getStatusBadge = (status: string | undefined) => { + const statusConfig = { + 'Active': { icon: CheckCircledIcon, color: 'bg-green-100 text-green-800 border-green-200' }, + 'Archived': { icon: ArchiveIcon, color: 'bg-gray-100 text-gray-800 border-gray-200' }, + 'Maintenance': { icon: UpdateIcon, color: 'bg-yellow-100 text-yellow-800 border-yellow-200' }, + 'In Development': { icon: ReloadIcon, color: 'bg-blue-100 text-blue-800 border-blue-200' }, + 'Under Construction': { icon: ComponentInstanceIcon, color: 'bg-orange-100 text-orange-800 border-orange-200' }, + } + const config = statusConfig[status as keyof typeof statusConfig] || statusConfig['Active'] + const Icon = config.icon + return ( + + + {status} + + ) + } + const getTechBadgeColor = (tech: string) => { const colors: Record = { 'JavaScript': 'bg-yellow-100 text-yellow-800 border-yellow-200', 'TypeScript': 'bg-blue-100 text-blue-800 border-blue-200', 'Python': 'bg-green-100 text-green-800 border-green-200', 'PHP': 'bg-purple-100 text-purple-800 border-purple-200', + 'Laravel': 'bg-red-100 text-red-800 border-red-200', + 'Vue.js': 'bg-emerald-100 text-emerald-800 border-emerald-200', + 'React': 'bg-cyan-100 text-cyan-800 border-cyan-200', + 'Next.js': 'bg-gray-100 text-gray-800 border-gray-200', 'HTML': 'bg-orange-100 text-orange-800 border-orange-200', 'CSS': 'bg-pink-100 text-pink-800 border-pink-200', - 'Go': 'bg-cyan-100 text-cyan-800 border-cyan-200', - 'Rust': 'bg-red-100 text-red-800 border-red-200', - 'Java': 'bg-amber-100 text-amber-800 border-amber-200', + 'Node.js': 'bg-lime-100 text-lime-800 border-lime-200', + 'MySQL': 'bg-indigo-100 text-indigo-800 border-indigo-200', } return colors[tech] || 'bg-secondary text-secondary-foreground border-border' } + const getCategoryBadge = (category: string | undefined) => { + if (!category) return null + const categoryColors: Record = { + 'Web Development': 'bg-blue-50 text-blue-700 border-blue-200', + 'E-commerce': 'bg-green-50 text-green-700 border-green-200', + 'Mobile App': 'bg-purple-50 text-purple-700 border-purple-200', + 'API/Backend': 'bg-orange-50 text-orange-700 border-orange-200', + 'Academic Project': 'bg-indigo-50 text-indigo-700 border-indigo-200', + 'Financial Management': 'bg-emerald-50 text-emerald-700 border-emerald-200', + 'Hotel Management': 'bg-rose-50 text-rose-700 border-rose-200', + } + const color = categoryColors[category] || 'bg-gray-50 text-gray-700 border-gray-200' + return ( + + {category} + + ) + } + return (
{/* Hero */}
-

Our Projects

+

Our Projects Portfolio

- Discover the open-source projects we're building to solve real-world problems - and empower developers worldwide. From SaaS platforms to AI/ML tools. + Explore our comprehensive collection of {allProjects.length} open-source projects spanning multiple technologies + and domains. From enterprise SaaS platforms to specialized tools, each project demonstrates our commitment to + quality, innovation, and community contribution.

+
+ {categories.slice(0, 6).map((category) => ( + + {category} + + ))} + {categories.length > 6 && ( + + +{categories.length - 6} more + + )} +
{/* Featured Projects */} {featuredProjects.length > 0 && (
-

Featured Projects

+
+

Featured Projects

+ + {featuredProjects.length} Active Projects + +
{featuredProjects.map((project) => ( - - -
-
- {project.name} - - {project.overview || project.description || 'No description available'} - + + + +
+ {project.name} + {project.primaryLanguage && ( + + {project.primaryLanguage} + + )}
- {project.primaryLanguage && ( - - {project.primaryLanguage} - +
+ {getStatusBadge(project.status)} + {getCategoryBadge(project.category)} +
+ + {project.overview || project.description || 'Innovative project demonstrating modern development practices and solving real-world challenges.'} + +
+ + {/* Key Features */} + {project.keyFeatures && project.keyFeatures.length > 0 && ( +
+

Key Features

+
    + {project.keyFeatures.slice(0, 3).map((feature, idx) => ( +
  • + • {feature.split(':')[0]} +
  • + ))} +
+
)} -
- - - {project.github && ( -
- {project.stars !== undefined && ( -
- - {project.stars} -
- )} - {project.forks !== undefined && ( -
- - {project.forks} + + {/* Tech Stack */} + {project.techStack && project.techStack.length > 0 && ( +
+

Tech Stack

+
+ {project.techStack.slice(0, 4).map((tech, idx) => ( + + {tech} + + ))} + {project.techStack.length > 4 && ( + + +{project.techStack.length - 4} + + )}
- )} -
- Updated: {project.lastUpdated || 'Unknown'}
-
- )} - {project.techStack && project.techStack.length > 0 && ( -
- {project.techStack.slice(0, 3).map((tech, idx) => ( - - {tech} - - ))} - {project.techStack.length > 3 && ( - - +{project.techStack.length - 3} more - - )} -
- )} - + )} + + {/* Project Stats */} + {project.github && ( +
+ {project.stars !== undefined && ( +
+ + {project.stars} +
+ )} + {project.forks !== undefined && ( +
+ + {project.forks} +
+ )} + {project.lastUpdated && ( +
+ + {project.lastUpdated} +
+ )} +
+ )} + + - {project.github && ( - - )} {project.liveDemo && ( - )} + {project.github && ( + + )} ))} @@ -129,109 +215,163 @@ export default function ProjectsPage() { {/* All Projects */} {otherProjects.length > 0 && (
-

All Projects

-
+
+

All Projects

+ + {allProjects.length} Total Projects + +
+
{otherProjects.map((project) => ( - - -
-
- {project.name} - {project.overview && ( - - {project.overview} - - )} -
- {project.primaryLanguage && ( - - {project.primaryLanguage} - - )} -
-
- -
-
- {project.stars !== undefined && ( -
- - {project.stars} + + + +
+
+ {project.name} +
+ {getStatusBadge(project.status)} + {getCategoryBadge(project.category)} + {project.visibility && ( + + {project.visibility === 'Public' ? ( + + ) : ( + + )} + {project.visibility} + + )}
- )} - {project.visibility && ( - - {project.visibility} - + {project.overview && ( + + {project.overview} + + )} +
+ {project.primaryLanguage && ( + + {project.primaryLanguage} + )}
-
- {project.github && ( - - )} - {project.liveDemo && ( - - )} + + + {/* Tech Stack */} + {project.techStack && project.techStack.length > 0 && ( +
+ {project.techStack.slice(0, 3).map((tech, idx) => ( + + {tech} + + ))} + {project.techStack.length > 3 && ( + + +{project.techStack.length - 3} more + + )} +
+ )} + +
+
+ {project.stars !== undefined && ( +
+ + {project.stars} +
+ )} + {project.lastUpdated && ( +
+ + {project.lastUpdated} +
+ )} +
+
+ {project.liveDemo && ( + + )} + {project.github && ( + + )} +
-
- + +
))}
)} + + {/* Portfolio Project */} - +
CodeStorm Hub Portfolio - A modern, accessible portfolio website built with Next.js, Tailwind CSS, and Radix UI + A modern, accessible, and high-performance portfolio website showcasing professional + web development practices and community-driven open source projects.
-
- Portfolio -
+ + ⭐ Showcase Project +
- -

- This portfolio website showcases modern web development practices using cutting-edge - technologies and design systems. It serves as both our community hub and a reference - implementation for best practices in web development. + +

+ This portfolio website demonstrates cutting-edge web development technologies and serves as both + our community hub and a reference implementation for modern web standards, accessibility best practices, + and performance optimization techniques.

-
- Next.js 15 - Tailwind CSS 4 - Radix UI - TypeScript +
+

Key Technologies

+
+ Next.js 15 + TypeScript + Tailwind CSS 4 + Radix UI + Vercel +
+
+
+

Features

+
    +
  • • Server-side rendering with optimal performance
  • +
  • • Full accessibility compliance (WCAG 2.1 AA)
  • +
  • • Responsive design with mobile-first approach
  • +
  • • Dark/light theme support
  • +
diff --git a/src/app/showcase/page.tsx b/src/app/showcase/page.tsx index 55834ab..50f308d 100644 --- a/src/app/showcase/page.tsx +++ b/src/app/showcase/page.tsx @@ -1,3 +1,4 @@ +import Link from "next/link" import { Container } from "@/components/ui/container" import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@/components/ui/card" import { Button } from "@/components/ui/button" @@ -385,9 +386,9 @@ export default function ShowcasePage() {

diff --git a/src/components/home/projects-section.tsx b/src/components/home/projects-section.tsx index 5cf8d23..68ff26e 100644 --- a/src/components/home/projects-section.tsx +++ b/src/components/home/projects-section.tsx @@ -1,10 +1,12 @@ +import Link from "next/link" import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@/components/ui/card" import { Container } from "@/components/ui/container" import { Typography } from "@/components/ui/typography" import { Grid } from "@/components/ui/grid" import { Stack } from "@/components/ui/stack" import { Button } from "@/components/ui/button" -import { GitHubLogoIcon, StarIcon, PersonIcon, ExternalLinkIcon } from "@radix-ui/react-icons" +import { Badge } from "@/components/ui/badge" +import { GitHubLogoIcon, StarIcon, PersonIcon, ExternalLinkIcon, CheckCircledIcon, ArchiveIcon, UpdateIcon, ReloadIcon, ComponentInstanceIcon } from "@radix-ui/react-icons" import { getFeaturedProjects } from "@/lib/project-data" interface ProjectsSectionProps { @@ -14,6 +16,24 @@ interface ProjectsSectionProps { export default function ProjectsSection({ className }: ProjectsSectionProps) { const featuredProjects = getFeaturedProjects(6) + const getStatusBadge = (status: string | undefined) => { + const statusConfig = { + 'Active': { icon: CheckCircledIcon, color: 'bg-green-100 text-green-800 border-green-200' }, + 'Archived': { icon: ArchiveIcon, color: 'bg-gray-100 text-gray-800 border-gray-200' }, + 'Maintenance': { icon: UpdateIcon, color: 'bg-yellow-100 text-yellow-800 border-yellow-200' }, + 'In Development': { icon: ReloadIcon, color: 'bg-blue-100 text-blue-800 border-blue-200' }, + 'Under Construction': { icon: ComponentInstanceIcon, color: 'bg-orange-100 text-orange-800 border-orange-200' }, + } + const config = statusConfig[status as keyof typeof statusConfig] || statusConfig['Active'] + const Icon = config.icon + return ( + + + {status} + + ) + } + return (

@@ -24,39 +44,84 @@ export default function ProjectsSection({ className }: ProjectsSectionProps) { Featured Projects - Explore our open source initiatives that are making a real impact in the developer community + Explore our open source initiatives showcasing modern development practices, + innovative solutions, and community-driven excellence across diverse technology domains. {/* Projects Grid */} {featuredProjects.map((project) => ( - - - + + + +
- {project.name} + + {project.name} + {project.primaryLanguage && ( - + {project.primaryLanguage} - + + )} +
+ +
+ {getStatusBadge(project.status)} + {project.category && ( + + {project.category} + )}
- {project.techStack && project.techStack.length > 0 && ( - - {project.techStack[0]} - - )}
- + - - {project.overview || project.description || "No description available."} + + {project.overview || project.description || "Innovative project demonstrating modern development practices and solving real-world challenges with cutting-edge technology."} + {/* Key Features Preview */} + {project.keyFeatures && project.keyFeatures.length > 0 && ( +
+

+ Key Features +

+
    + {project.keyFeatures.slice(0, 2).map((feature, idx) => ( +
  • + • {feature.split(':')[0]} +
  • + ))} +
+
+ )} + + {/* Tech Stack */} + {project.techStack && project.techStack.length > 0 && ( +
+

+ Technologies +

+
+ {project.techStack.slice(0, 3).map((tech, idx) => ( + + {tech} + + ))} + {project.techStack.length > 3 && ( + + +{project.techStack.length - 3} + + )} +
+
+ )} + {/* Project Stats */} -
+
{project.stars !== undefined && (
)} -
- - {/* Action Buttons */} -
- {project.liveDemo && ( - - )} - {project.github && ( - + {project.lastUpdated && ( +
+ Updated {project.lastUpdated} +
)}
+ +
+ {/* Action Buttons */} +
+ {project.liveDemo && ( + + )} + {project.github && ( + + )} +
+
))} {/* View All Projects CTA */} - diff --git a/src/components/ui/badge.tsx b/src/components/ui/badge.tsx new file mode 100644 index 0000000..e73e385 --- /dev/null +++ b/src/components/ui/badge.tsx @@ -0,0 +1,35 @@ +import * as React from "react" +import { cva, type VariantProps } from "class-variance-authority" +import { cn } from "@/lib/utils" + +const badgeVariants = cva( + "inline-flex items-center rounded-md border px-2 py-1 text-xs font-medium transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2", + { + variants: { + variant: { + default: + "border-transparent bg-primary text-primary-foreground shadow hover:bg-primary/80", + secondary: + "border-transparent bg-secondary text-secondary-foreground hover:bg-secondary/80", + destructive: + "border-transparent bg-destructive text-destructive-foreground shadow hover:bg-destructive/80", + outline: "text-foreground", + }, + }, + defaultVariants: { + variant: "default", + }, + } +) + +export interface BadgeProps + extends React.HTMLAttributes, + VariantProps {} + +function Badge({ className, variant, ...props }: BadgeProps) { + return ( +
+ ) +} + +export { Badge, badgeVariants } \ No newline at end of file diff --git a/src/components/ui/separator.tsx b/src/components/ui/separator.tsx new file mode 100644 index 0000000..88a3c74 --- /dev/null +++ b/src/components/ui/separator.tsx @@ -0,0 +1,28 @@ +import * as React from "react" +import * as SeparatorPrimitive from "@radix-ui/react-separator" +import { cn } from "@/lib/utils" + +const Separator = React.forwardRef< + React.ElementRef, + React.ComponentPropsWithoutRef +>( + ( + { className, orientation = "horizontal", decorative = true, ...props }, + ref + ) => ( + + ) +) +Separator.displayName = SeparatorPrimitive.Root.displayName + +export { Separator } \ No newline at end of file diff --git a/src/lib/project-data.ts b/src/lib/project-data.ts index 0469601..d0521a6 100644 --- a/src/lib/project-data.ts +++ b/src/lib/project-data.ts @@ -13,13 +13,18 @@ export interface ProjectData { stars?: number forks?: number lastUpdated?: string - status?: 'Active' | 'Archived' | 'Maintenance' + status?: 'Active' | 'Archived' | 'Maintenance' | 'In Development' | 'Under Construction' visibility?: 'Public' | 'Private' liveDemo?: string techStack?: string[] architecture?: string repositorySize?: string content: string + keyFeatures?: string[] + category?: string + tags?: string[] + prerequisites?: string[] + contributors?: string[] } let cachedProjectsData: ProjectData[] | null = null @@ -77,17 +82,39 @@ function parseProjectMarkdown(content: string, slug: string): Partial line.includes('## Overview')) - if (overviewIndex > -1 && overviewIndex < lines.length - 2) { - const descriptionLine = lines[overviewIndex + 2] - if (descriptionLine && !descriptionLine.startsWith('#')) { - data.overview = descriptionLine.trim() + if (overviewIndex > -1) { + // Find the first non-empty line after ## Overview (skip empty lines) + for (let i = overviewIndex + 1; i < lines.length; i++) { + const line = lines[i].trim() + if (line && !line.startsWith('#') && !line.startsWith('##')) { + data.overview = line + break + } } } + // Extract key features - Look for ## ✨ Key Features section + const featuresIndex = lines.findIndex(line => line.includes('## ✨ Key Features') || line.includes('## Key Features')) + if (featuresIndex > -1) { + const features: string[] = [] + for (let i = featuresIndex + 1; i < lines.length; i++) { + const line = lines[i].trim() + if (line.startsWith('##')) break // Stop at next section + if (line.startsWith('- **') && line.includes(':**')) { + // Extract feature name and description + const featureMatch = line.match(/- \*\*([^*]+):\*\* (.+)/) + if (featureMatch) { + features.push(`${featureMatch[1]}: ${featureMatch[2]}`) + } + } + } + data.keyFeatures = features + } + // Extract GitHub URL - const githubMatch = content.match(/- \*\*GitHub:\*\* (https:\/\/github\.com\/[^\s\n]+)/) + const githubMatch = content.match(/- \*\*GitHub:\*\* (https:\/\/github\.com\/[^\s\n\]]+)/) if (githubMatch) { data.github = githubMatch[1] } @@ -122,10 +149,10 @@ function parseProjectMarkdown(content: string, slug: string): Partial tag.replace('#', '').trim()).filter(tag => tag.length > 0) + } + + // Extract tech stack from multiple possible locations + const techMatch = content.match(/- \*\*Technology Stack:\*\* (.+)/) || + content.match(/- \*\*Framework:\*\* (.+)/) if (techMatch) { - data.techStack = techMatch[1].split(',').map(tech => tech.trim()) + data.techStack = techMatch[1].split(/[,/]/).map(tech => tech.trim()) + } else { + // Fallback: extract from Primary Technologies section + const primaryTechIndex = lines.findIndex(line => line.includes('### Primary Technologies')) + if (primaryTechIndex > -1) { + const techStack: string[] = [] + for (let i = primaryTechIndex + 1; i < lines.length; i++) { + const line = lines[i].trim() + if (line.startsWith('###') || line.startsWith('##')) break + if (line.startsWith('- **') && line.includes(':**')) { + const techMatch = line.match(/- \*\*([^*]+):\*\*/) + if (techMatch) { + techStack.push(techMatch[1]) + } + } + } + data.techStack = techStack + } } // Extract architecture @@ -152,6 +209,32 @@ function parseProjectMarkdown(content: string, slug: string): Partial line.includes('### Prerequisites')) + if (prerequisitesIndex > -1) { + const prerequisites: string[] = [] + for (let i = prerequisitesIndex + 1; i < lines.length; i++) { + const line = lines[i].trim() + if (line.startsWith('###') || line.startsWith('##')) break + if (line.startsWith('-') && !line.startsWith('- **')) { + prerequisites.push(line.replace(/^- /, '').trim()) + } + } + data.prerequisites = prerequisites + } + + // Extract contributors + const contributorsMatch = content.match(/- \*\*Lead Developer:\*\* \[([^\]]+)\]/) + if (contributorsMatch) { + data.contributors = [contributorsMatch[1]] + } + return data } @@ -170,4 +253,23 @@ export function getProjectsByTechnology(tech: string): ProjectData[] { project.techStack?.some(t => t.toLowerCase().includes(tech.toLowerCase())) || project.primaryLanguage?.toLowerCase().includes(tech.toLowerCase()) ) +} + +export function getProjectsByCategory(category: string): ProjectData[] { + return getAllProjects().filter(project => + project.category?.toLowerCase().includes(category.toLowerCase()) + ) +} + +export function getAllCategories(): string[] { + const categories = getAllProjects() + .map(project => project.category) + .filter((category): category is string => Boolean(category)) + return Array.from(new Set(categories)).sort() +} + +export function getAllTags(): string[] { + const tags = getAllProjects() + .flatMap(project => project.tags || []) + return Array.from(new Set(tags)).sort() } \ No newline at end of file