diff --git a/submissions/PrePortal-Inheritance.md b/submissions/PrePortal-Inheritance.md new file mode 100644 index 0000000..507535c --- /dev/null +++ b/submissions/PrePortal-Inheritance.md @@ -0,0 +1,160 @@ +# VJTI PrepPortal + +## Description + +VJTI PrepPortal is a student-focused placement preparation platform developed to centralize placement experiences, preparation roadmaps, and peer guidance within a single system. + +The project addresses the problem of scattered placement information by allowing students to share experiences, track their preparation journey, and access placement-related resources through a structured web interface. + +The system is built using the **MERN stack (MongoDB, Express.js, React.js, Node.js)**. + +--- + +## Links + +- **GitHub Repository** + https://github.com/ststst31/inheritance-vjtipreportal-stesha + +- **Demo Video** + https://drive.google.com/file/d/1AtuZtjOEj_wmAYKJoWE9LviwRi3gUD2J/view?usp=sharing + +- **Project Screenshots / Drive** + https://drive.google.com/drive/folders/1yRsVpl8cp3uWD_cMjWMxB20jBFazh_Vy?dmr=1&ec=wgc-drive-%5Bmodule%5D-goto + +- **Hosted Website** + Not hosted + +--- + +## Tech Stack + +### Frontend +- React.js +- JavaScript (ES6) +- HTML5 +- CSS3 +- Axios + +### Backend +- Node.js +- Express.js +- REST API Architecture + +### Database +- MongoDB (Mongoose ODM) + +--- + +## System Architecture + +The system follows a standard client–server architecture: + +- The React frontend handles UI rendering and user interaction. +- The Express backend manages API requests and business logic. +- MongoDB stores user data, posts, and placement roadmap information. +- Communication between frontend and backend is handled through REST APIs. + +--- + +## Project Progress + +### Fully Implemented Features + +- **User Authentication:** + Students can sign up, log in, and maintain individual profiles. + +- **Profile Management:** + Users can update profile information, upload profile pictures and resumes, and maintain a placement roadmap. + +- **Placement Roadmap Tracking:** + Users can add preparation steps categorized as *Applied*, *Interview Process*, or *Placed*. + +- **Experience Posting System:** + Students can share placement experiences and preparation insights with timestamps. + +- **User Search:** + Search functionality to find other users and view their profiles. + +- **Dark Mode Interface:** + Theme switching for improved usability. + +--- + +### Partially Implemented Features / Work in Progress + +- **UI Enhancements:** + Minor improvements in layout responsiveness and visual consistency are ongoing. + +- **Post Interaction Features:** + Commenting and engagement features are planned but not implemented in the current version. + +--- + +## Future Scope + +- Deployment on cloud platforms for public access +- Admin moderation and content filtering +- Analytics dashboard for placement statistics +- Improved search filtering and tagging system +- Notification system for updates and announcements + +--- + +## Applications + +- **Academic Placement Communities:** + Helps students share preparation strategies and experiences in a structured manner. + +- **College Placement Cells:** + Can serve as an internal platform for organizing placement information and student progress tracking. + +--- + +## Project Setup + +### 1. Clone the Repository + +```bash +git clone https://github.com/ststst31/inheritance-vjtipreportal-stesha +``` + +### 2. Install Dependencies + +```bash +cd main +npm install +``` + +### 3. Run Backend + +```bash +cd server +node index.js +``` + +### 4. Run Frontend + +```bash +cd client +npm run dev +``` + +--- + +## Team Members + +- **Stesha Parkhe** + https://github.com/ststst31 + +- **Ali Shaikh** + https://github.com/aly-shaikh + +--- + +## Mentors + +- **Ojas** + https://github.com/Ojasp21 + +- **Gaurav Sharma** + https://github.com/gsgit123/