|
| 1 | + |
| 2 | +# Project Roadmap |
| 3 | + |
| 4 | +This document outlines the planned phases and major milestones for ComputerScienceResources.com. It is intended for contributors and anyone interested in the long-term vision of the project. |
| 5 | + |
| 6 | +--- |
| 7 | + |
| 8 | +## Phase 0: Planning (Completed January 2025) |
| 9 | +**Goal:** Establish a solid foundation for the application. |
| 10 | +- Define requirements and specifications |
| 11 | +- Create paper UI designs |
| 12 | +- Set PHP conventions and development environment |
| 13 | +- Draft initial documentation and README |
| 14 | + |
| 15 | +## Phase 1: Core Application Features (February–March 2025) |
| 16 | +**Goal:** Deliver the minimum viable product (MVP) with essential resource and community features. |
| 17 | +- Resource creation with all required fields |
| 18 | +- Detailed resource view pages |
| 19 | +- Upvoting and downvoting for resources |
| 20 | +- Resource reviews (one per user per resource) |
| 21 | + - Reviews can be upvoted, commented on, edited, and affect resource averages |
| 22 | +- Comment system supporting nested, paginated comments on any commentable model |
| 23 | +- Voting system for resources and comments (upvote, downvote, remove vote) |
| 24 | +- Resource posting rules and moderation (see Rules folder) |
| 25 | +- Frontend designed for clarity and usability |
| 26 | + |
| 27 | +**Target Completion:** Early March 2025 |
| 28 | + |
| 29 | +## Phase 2: Resource Editing & Community Review (April 2025) |
| 30 | +**Goal:** Enable collaborative editing and transparent review of resource information. |
| 31 | +- Users can propose edits to resources |
| 32 | +- View and paginate all pending edits |
| 33 | +- Stale edits are automatically removed after 4 months |
| 34 | +- View, comment on, and compare proposed changes with originals |
| 35 | +- Public approval/disapproval system for edits, with clear voting rules |
| 36 | +- Edit creators can merge changes after sufficient community approval |
| 37 | +- Archived and deleted edits are properly managed |
| 38 | + |
| 39 | +**Target Completion:** End of April 2025 |
| 40 | + |
| 41 | +## Phase 3: Dynamic Tag Search (May 2025) |
| 42 | +**Goal:** Improve discoverability through advanced tag management. |
| 43 | +- Search and autofill tags in the frontend |
| 44 | +- Tags sorted by frequency of use |
| 45 | +- Tag usage counts increase as resources are created |
| 46 | + |
| 47 | +**Target Completion:** Mid-May 2025 |
| 48 | + |
| 49 | +## Phase 4: Resource Filtering (Late May 2025) |
| 50 | +**Goal:** Allow users to filter and find resources efficiently. |
| 51 | +- Filter resources by any column (name, description, platforms, difficulty, pricing, tags, upvotes, review scores, etc.) |
| 52 | + |
| 53 | +**Target Completion:** End of May 2025 |
| 54 | + |
| 55 | +## Phase 5: User Profiles & Permissions (June 2025) |
| 56 | +**Goal:** Implement user management and permissions. |
| 57 | +- User profile creation and management |
| 58 | +- Email verification and secure authentication (GitHub, Google) |
| 59 | +- Activity logging and user history |
| 60 | +- User deletion with appropriate data retention or removal |
| 61 | +- Profile editing (email, username, etc.) |
| 62 | +- Permission controls to ensure users can only edit their own data |
| 63 | + |
| 64 | +**Target Completion:** Mid-June 2025 |
| 65 | + |
| 66 | +## Phase 6: Backend Refactor & Security (July 2025) |
| 67 | +**Goal:** Refine backend architecture and improve security. |
| 68 | +- Refactor models for better maintainability (fillable/guarded) |
| 69 | +- Cascade deletes and handle polymorphic relationships |
| 70 | +- Integrate admin panel (Filament) |
| 71 | +- Improve logging and monitoring |
| 72 | +- Address unfinished requirements and outstanding issues |
| 73 | + |
| 74 | +**Target Completion:** Early July 2025 |
| 75 | + |
| 76 | +## Phase 7: UI/UX Enhancements (July–August 2025) |
| 77 | +**Goal:** Polish the user interface and experience. |
| 78 | +- Add About page and toast notifications |
| 79 | +- Implement a user-friendly search bar with query parameter support |
| 80 | +- Ensure robust testing and logging |
| 81 | +- Integrate anti-spam and security features |
| 82 | + |
| 83 | +**Target Completion:** Early August 2025 |
| 84 | + |
| 85 | +## Phase 8: Hosting, Deployment & Documentation (August–September 2025) |
| 86 | +**Goal:** Prepare for production and public release. |
| 87 | +- Finalize README, license, and contributing guide |
| 88 | +- Set up backups, analytics, and monitoring |
| 89 | +- Deploy to VPS with Docker |
| 90 | +- Integrate analytics and backup solutions |
| 91 | + |
| 92 | +**Target Completion:** Early September 2025 |
| 93 | + |
| 94 | +## Phase 9: Community & Feature Expansion (Ongoing) |
| 95 | +**Goal:** Foster community engagement and expand features based on feedback. |
| 96 | +- Add Discussions, Bugs, and Feature Request sections |
| 97 | +- Enhance moderation and quality control |
| 98 | +- Add learning paths, resource lists, and favoriting |
| 99 | +- Support for alternative/similar resources, prerequisites, and certifications |
| 100 | + |
| 101 | +## Phase 10: Future Growth & Innovation |
| 102 | +**Goal:** Explore new opportunities and expand the platform. |
| 103 | +- Consider new domains (e.g. newsletters) |
| 104 | +- Integrate new features and community-driven ideas |
| 105 | +- Continue to improve based on user feedback and needs |
| 106 | + |
| 107 | +--- |
| 108 | + |
| 109 | +This roadmap is subject to change based on community feedback and evolving project needs. For the latest updates, check this file or open a discussion in the repository. |
0 commit comments