{"id":23305893,"url":"https://github.com/maneesha-raj/reviewappproject","last_synced_at":"2025-04-06T23:47:09.206Z","repository":{"id":250547671,"uuid":"834768090","full_name":"Maneesha-Raj/ReviewAppProject","owner":"Maneesha-Raj","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-02T01:23:03.000Z","size":4281,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-13T05:45:49.397Z","etag":null,"topics":["html-css-javascript","jwt-authentication","mern-project","multer","web2"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Maneesha-Raj.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-28T09:53:44.000Z","updated_at":"2024-12-05T10:19:29.000Z","dependencies_parsed_at":"2024-07-28T11:02:03.389Z","dependency_job_id":"3ec7fe8d-4ae9-4fb9-8b57-30838f688d7d","html_url":"https://github.com/Maneesha-Raj/ReviewAppProject","commit_stats":null,"previous_names":["maneesha-raj/review_app_docker"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Maneesha-Raj%2FReviewAppProject","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Maneesha-Raj%2FReviewAppProject/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Maneesha-Raj%2FReviewAppProject/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Maneesha-Raj%2FReviewAppProject/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Maneesha-Raj","download_url":"https://codeload.github.com/Maneesha-Raj/ReviewAppProject/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247569132,"owners_count":20959758,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["html-css-javascript","jwt-authentication","mern-project","multer","web2"],"created_at":"2024-12-20T12:14:30.723Z","updated_at":"2025-04-06T23:47:09.180Z","avatar_url":"https://github.com/Maneesha-Raj.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# 🌟 REVO: REVIEW APP\n\n## 📄 PROJECT OVERVIEW\n\n**REVO: REVIEW APP** is a modern web application built with **React.js** to allow users to view and review products. The application supports two user roles: **Admin** and **Registered User**, with tailored functionalities for managing products and reviews.  \n\n---\n\n## 🔑 FEATURES\n\n### 👤 Registered User Features\n- **Search Products:** Filter products by category.\n- **View Product Details:** See detailed information about products.\n- **Write Reviews:** Add reviews for products.\n- **View User Reviews:** Manage and view reviews written by the user.\n\n### 🛠️ Admin Features\n- **Add Products:** Add new products through an intuitive form.\n- **Search Products:** Filter and search for products by category.\n- **Delete Products:** Remove unnecessary or outdated products.\n- **View Product Details:** View detailed product information.\n\n---\n\n## ⚙️ TECHNOLOGIES USED\n\n### **Frontend:**\n- React.js\n- Tailwind CSS\n- React Router\n\n### **Backend:**\n- Node.js\n- Express.js\n\n### **Database:**\n- MongoDB\n\n---\n\n## 🛠️ OTHER TOOLS\n\n- **Docker:** Simplifies app deployment and environment setup.\n- **JWT Authentication:** Ensures secure user sessions and authentication.\n- **Reusable UI Components:** Maintain consistency and ease of development.\n\n---\n\n## 👥 USER ROLES AND PERMISSIONS\n\n| **Role**         | **Permissions**                                                                 |\n|-------------------|---------------------------------------------------------------------------------|\n| **Admin**         | Add, delete, and manage products, and view product details.                    |\n| **Registered User** | Search and review products, view detailed information, and manage own reviews.|\n\n---\n\n## 📌 FUTURE ENHANCEMENTS\n\n- **Advanced Product Filtering:** Introduce filters based on price, ratings, and categories.\n- **Rating System:** Aggregate and display average ratings for products.\n- **Admin Dashboard:** Add insights like total products, reviews, and user activities.\n- **Email Notifications:** Notify users of updates or important events.\n\n---\n\n## 🚀 GETTING STARTED\n\n### **Prerequisites**\n1. Install Docker on your system.\n\n### **Setup Steps**\n\n1. **Clone the Repository:**\n   ```bash\n   git clone https://github.com/Maneesha-Raj/REVIEW_APP_DOCKER.git\n   cd REVIEW_APP_DOCKER\n\n## How to install:\n- git clone  https://github.com/Maneesha-Raj/REVIEW_APP_DOCKER.git\n- To run: `docker compose up --build`\n- You can access the application in your web browser at : `http://localhost:3000`\n\n## Links:\n- Demo Video link : https://drive.google.com/file/d/1bw5WrFzQHJ7lqOqikR2IMikJwqPyQgd_/view?usp=drive_link\n- Workflow diagram link : https://drive.google.com/file/d/1Z6FeUn8_tFqJaxobW3GE7hLCPwVaRrsk/view?usp=drive_link\n- Documentation : https://drive.google.com/file/d/1bd0S3NiggWzdJUhkUVej7DT0ap6FSYHj/view?usp=sharing\n- PPT : https://drive.google.com/file/d/1sebTn-1Rx9TzY9W2-NokjCg927UVxv4Q/view?usp=drive_link\n\n\n\n\n\n\n\n\n\u003c!-- //----------------------------------------------------------------------------------------- --\u003e\n\n\u003c!-- # REVO:REVIEW APP\n\nThis application allows users to view and review products, with different functionalities based on user roles: Admin, and User. The Review App is a web application built with React.js. It allows users to view, search, and review products.\n\nThe application has two main types of users:\n\n1. **Admin**: Can manage products by adding, searching and deleting products.\n2. **User**: Can view products, search for them, and write reviews.\n   \n- **User Authentication** :  Handles user registration, login, logout, and authentication. It ensures that users can securely access the app and their data.\n- **Review Management** :  Deals with creating, reading and viewing reviews. It includes functionalities like adding a review and viewing reviews.\n- **Product Management** :  Manages the products or items that users can review. It includes functionalities like adding new products, searching for products  and deleting products.\n- **UI Components** :  Contains reusable UI components such as buttons, forms and cards. It helps maintain consistency in the app's appearance and makes it easier to build and maintain the user interface.\n- \n## User Roles and Functionalities\n### **Admin**\n- Sign Up: Create an admin account.\n- Login: Access the admin dashboard upon successful login.\n### **Admin Home Page:**\n- Header: Includes links to Home, Add Product, and a Search Bar.\n- Product Cards: Each card has \"View\" and \"Delete\" buttons.\n- Search Products: Search for products by category.\n- Add Product Link: Navigate to a form to add new products.\n### **Admin Functions:**\n- Add Product: Fill out a form to add new products.\n- Delete Product: Remove products from the list.\n- Search Products: Filter products based on category.\n### **Registered User**\n- Sign Up: Create a user account.\n- Login: Access the user home page upon successful login.\n### **User Home Page:**\n- Header: Includes links to Home, User Reviews, and a Search Bar.\n- Product Cards: Each card has a \"View\" button.\n- Search Products: Search for products by category.\n- User Reviews Link: Navigate to a list of reviews made by the user.\n### **Registered User Functions:**\n- Search Products: Filter products based on category.\n- View Product Details: See detailed information about a product.\n- Write Your Reviews: Write reviews to a product.\n- View Your Reviews: View reviews written by the user.\n\n## How to install:\n- git clone  https://github.com/Maneesha-Raj/REVIEW_APP_DOCKER.git\n- To run: docker compose up --build\n- You can access the application in your web browser at : http://localhost:3000\n\n## Links:\n- Demo Video link : https://drive.google.com/file/d/1bw5WrFzQHJ7lqOqikR2IMikJwqPyQgd_/view?usp=drive_link\n- Workflow diagram link : https://drive.google.com/file/d/1Z6FeUn8_tFqJaxobW3GE7hLCPwVaRrsk/view?usp=drive_link\n- Documentation : https://drive.google.com/file/d/1bd0S3NiggWzdJUhkUVej7DT0ap6FSYHj/view?usp=sharing\n- PPT : https://drive.google.com/file/d/1sebTn-1Rx9TzY9W2-NokjCg927UVxv4Q/view?usp=drive_link --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaneesha-raj%2Freviewappproject","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaneesha-raj%2Freviewappproject","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaneesha-raj%2Freviewappproject/lists"}