diff --git a/.env.example b/.env.example index deda4bcc..36195800 100644 --- a/.env.example +++ b/.env.example @@ -22,11 +22,11 @@ LOG_DEPRECATIONS_CHANNEL=null LOG_LEVEL=debug DB_CONNECTION=sqlite -# DB_HOST=127.0.0.1 -# DB_PORT=3306 -# DB_DATABASE=computer_science_resources -# DB_USERNAME=root -# DB_PASSWORD= +DB_HOST=127.0.0.1 +DB_PORT=3306 +DB_DATABASE=computer_science_resources +DB_USERNAME=root +DB_PASSWORD= SESSION_DRIVER=database SESSION_LIFETIME=120 @@ -64,3 +64,6 @@ AWS_BUCKET= AWS_USE_PATH_STYLE_ENDPOINT=false VITE_APP_NAME="${APP_NAME}" + +SAIL_XDEBUG_MODE=develop,debug,coverage +SAIL_XDEBUG_CONFIG="discover_client_host=1 client_port=9003" diff --git a/README.md b/README.md index 82afbcce..3d0915e0 100644 --- a/README.md +++ b/README.md @@ -6,26 +6,34 @@ Welcome to the codebase for [ComputerScienceResources.com](https://computerscienceresources.com) — a curated platform for discovering, reviewing, and sharing the best resources in computer science and software engineering. -![Computer Science Logo](public/images/Logo.svg) -

This is our mascot, look how studious this little guy is!

+

+Computer Science Resources Logo +This is our mascot, look how studious this little guy is! +

This website helps developers and learners find high-quality, structured, and community-reviewed resources across all areas of computer science. Our mission is to make learning easier by organizing and highlighting the best content, and to empower the community to contribute, review, and improve resource listings. ## App Features -Here's what you can do on ComputerScienceResources.com — all designed to make your learning journey easier, more fun, and community-driven: +Here's what you can do on ComputerScienceResources.com — all designed to make your learning journey easier: - **Add New Resources:** Share your favorite computer science and software engineering resources with the world. - **Upvote & Downvote:** Show your support (or not!) for resources, reviews, and comments. Change your mind? You can always update or remove your vote. - **Write Reviews:** Leave thoughtful reviews for resources you’ve tried. Each user can post one review per resource, and reviews can be upvoted, commented on, and edited. -- **Comment Anywhere:** Start conversations on resources, reviews, or even other comments. Comments are nested, paginated, and easy to follow — just like your favorite forums. +- **Comment Anywhere:** Start conversations on resources, reviews, or even other comments. Comments are nested, paginated, and easy to follow — just like your favorite forums: Reddit and Hackernews. - **Suggest Edits:** See something that could be improved? Propose edits to any resource. The community can discuss, vote, and help merge the best changes. - **Resource Filtering:** Filter resources by name, description, platform, difficulty, pricing, tags, upvotes, review scores, and more — so you always find what you need. - **Community-Driven:** Everything is built to encourage helpfulness, kindness, and collaboration. Your feedback, reviews, and suggestions shape the site! We’re always improving and adding new features. If you have ideas or want to help, check out the Contributing section below! +## Contributing + +We welcome contributions! Please open issues or pull requests. For suggestions of features, please use the Discussions tab. + +Don't be afraid to put up a PR or address any of the open issues in the tabs! + ## Getting Started This project uses [Laravel 11](https://laravel.com/) (PHP 8.2+) as the backend framework, with [Inertia.js](https://inertiajs.com/) and [Vue 3](https://vuejs.org/) for the frontend. @@ -179,11 +187,6 @@ Xdebug is pre-configured in the Sail Docker environment for local debugging. - [Project Roadmap](docs/ROADMAP.md): See the planned phases and milestones for the project. - [Application Routes & UI Previews](docs/ROUTES.md): Browse all main routes and their associated UI images. -## Contributing - -We welcome contributions! Please open issues or pull requests. For suggestions of features, please use the Discussions tab. - - ## License This project is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). diff --git a/docs/ROADMAP.md b/docs/ROADMAP.md index a2a2c0e8..51279c6d 100644 --- a/docs/ROADMAP.md +++ b/docs/ROADMAP.md @@ -93,7 +93,6 @@ This document outlines the planned phases and major milestones for ComputerScien ## Phase 9: Community & Feature Expansion (Ongoing) **Goal:** Foster community engagement and expand features based on feedback. -- Add Discussions, Bugs, and Feature Request sections - Enhance moderation and quality control - Add learning paths, resource lists, and favoriting - Support for alternative/similar resources, prerequisites, and certifications diff --git a/docs/ROUTES.md b/docs/ROUTES.md index af7c950f..ce8e333c 100644 --- a/docs/ROUTES.md +++ b/docs/ROUTES.md @@ -16,20 +16,25 @@ This document groups the main routes of ComputerScienceResources.com by category ## Resource-Related Routes -- `/` — Home (redirects to resource index) - - ![Home](routes-images/home.png) +- `/` — Resources (redirects to resource index) + - ![Resources](routes-images/resources.png) + - Filter Bar + ![Resource Filter Bar](routes-images/resources-filter-bar.png) - `/about` — About page - - ![About](routes-images/about.png) -- `/resources` — Resource index (list, filter, search) - - ![Resource Index](routes-images/resources-index.png) + - ![About](routes-images/about-us.png) - `/resources/create` — Create a new resource - ![Create Resource](routes-images/create-resource.png) - `/resources/{slug}` — Resource details (reviews, comments, tags) - - ![Resource Details](routes-images/resource-details.png) -- `/resources/{slug}/{tab?}` — Resource details with optional tab (e.g., reviews, comments) + - ![Resource Details Reviews](routes-images/resource-reviews.png) + - ![Resource Details Comments](routes-images/resource-comments.png) + - ![Resource Details Proposed Edits](routes-images/resource-proposed-edits.png) - `/resource/{slug}/edit/create` — Propose edits to a resource - - ![Edit Resource](routes-images/edit-resource.png) + - ![Edit Resource](routes-images/edits-create.png) - `/resource/edit/{slug}` — View pending edits for a resource + - ![Pending Edits Split Diff](routes-images/edits-show.png) + - ![Pending Edits Unified View](routes-images/edits-show-diff.png) + + ## Comment-Related Routes @@ -37,18 +42,27 @@ This document groups the main routes of ComputerScienceResources.com by category - ![Comments](routes-images/comments.png) - `/comments` — Post a new comment (API) + + ## Voting Routes - `/upvote/{typeKey}/{id}` — Upvote a resource, review, or comment (API) + - ![Upvote Example](routes-images/votes-upvote.png) - `/downvote/{typeKey}/{id}` — Downvote a resource, review, or comment (API) + - ![Downvote Example](routes-images/votes-downvote.png) + ## Review Routes - `/reviews/{computerScienceResource}` — Post or update a review (API) + - ![Write Review](routes-images/create-review.png) + + ## Other Routes -- `/tags/search/{query}` — API endpoint for searching tags (no UI screenshot) +- `/tags/search/{query}` — API endpoint for searching tags + - ![Tag Search](routes-images/tag-search.png) --- diff --git a/docs/routes-images/about-us.png b/docs/routes-images/about-us.png new file mode 100644 index 00000000..617f11ad Binary files /dev/null and b/docs/routes-images/about-us.png differ diff --git a/docs/routes-images/comments-sorting.png b/docs/routes-images/comments-sorting.png new file mode 100644 index 00000000..3e97d740 Binary files /dev/null and b/docs/routes-images/comments-sorting.png differ diff --git a/docs/routes-images/create-resource.png b/docs/routes-images/create-resource.png new file mode 100644 index 00000000..ce5609ca Binary files /dev/null and b/docs/routes-images/create-resource.png differ diff --git a/docs/routes-images/create-review.png b/docs/routes-images/create-review.png new file mode 100644 index 00000000..4ee5b568 Binary files /dev/null and b/docs/routes-images/create-review.png differ diff --git a/docs/routes-images/edits-create.png b/docs/routes-images/edits-create.png new file mode 100644 index 00000000..87ac1bd1 Binary files /dev/null and b/docs/routes-images/edits-create.png differ diff --git a/docs/routes-images/edits-show-diff.png b/docs/routes-images/edits-show-diff.png new file mode 100644 index 00000000..88b286cd Binary files /dev/null and b/docs/routes-images/edits-show-diff.png differ diff --git a/docs/routes-images/edits-show.png b/docs/routes-images/edits-show.png new file mode 100644 index 00000000..dc57ad2b Binary files /dev/null and b/docs/routes-images/edits-show.png differ diff --git a/docs/routes-images/resource-comments.png b/docs/routes-images/resource-comments.png new file mode 100644 index 00000000..80be2b91 Binary files /dev/null and b/docs/routes-images/resource-comments.png differ diff --git a/docs/routes-images/resource-proposed-edits.png b/docs/routes-images/resource-proposed-edits.png new file mode 100644 index 00000000..624bfd4e Binary files /dev/null and b/docs/routes-images/resource-proposed-edits.png differ diff --git a/docs/routes-images/resource-reviews.png b/docs/routes-images/resource-reviews.png new file mode 100644 index 00000000..194c0d9a Binary files /dev/null and b/docs/routes-images/resource-reviews.png differ diff --git a/docs/routes-images/resources-filter-bar.png b/docs/routes-images/resources-filter-bar.png new file mode 100644 index 00000000..8976ae0a Binary files /dev/null and b/docs/routes-images/resources-filter-bar.png differ diff --git a/docs/routes-images/resources.png b/docs/routes-images/resources.png new file mode 100644 index 00000000..b82fca42 Binary files /dev/null and b/docs/routes-images/resources.png differ diff --git a/docs/routes-images/tag-search.png b/docs/routes-images/tag-search.png new file mode 100644 index 00000000..b2b86b27 Binary files /dev/null and b/docs/routes-images/tag-search.png differ diff --git a/docs/routes-images/votes-downvote.png b/docs/routes-images/votes-downvote.png new file mode 100644 index 00000000..097f43b3 Binary files /dev/null and b/docs/routes-images/votes-downvote.png differ diff --git a/docs/routes-images/votes-upvote.png b/docs/routes-images/votes-upvote.png new file mode 100644 index 00000000..de1e8733 Binary files /dev/null and b/docs/routes-images/votes-upvote.png differ diff --git a/resources/js/Components/Resources/Reviews/CreateResourceReview.vue b/resources/js/Components/Resources/Reviews/CreateResourceReview.vue index ea6527f8..4261afd2 100644 --- a/resources/js/Components/Resources/Reviews/CreateResourceReview.vue +++ b/resources/js/Components/Resources/Reviews/CreateResourceReview.vue @@ -102,7 +102,6 @@ const submitReview = async (event) => { } else { routeParams.sort_by = "latest"; } - console.log(routeParams); router.visit(route('resources.show', routeParams)); }) .catch((err) => {