A comprehensive college management platform for Vishwakarma Institute of Technology (VIT Pune) that connects students, facilitates communication, and streamlines campus life.
- Intelligent assistant powered by Google Generative AI
- Instant answers about admissions, programs, fees, and campus facilities
- Context-aware responses for better user experience
- Connect with fellow students
- Share posts with photo upload support
- Like, comment, and engage with the community
- Real-time feed updates
- Upload and share study materials
- Organize notes by subject and semester
- Download resources shared by peers
- Collaborative learning environment
- Training & placement updates
- Club events and activities
- Important announcements
- Deadline reminders
- Report lost items with photo upload
- Browse found items
- Filter by category (Electronics, Documents, Personal Items, etc.)
- Contact information for item recovery
- Discover 8+ active college clubs
- Detailed club information and activities
- Meeting schedules and locations
- Direct contact and join functionality
- Categories: Technical, Cultural, Social Service, Entrepreneurship, and more
- Personalized student profiles
- Department and batch information
- Activity tracking
- Secure authentication
- Frontend Framework: React 18.3.1
- Language: TypeScript 5.8.3
- Styling: Tailwind CSS 3.4.17
- UI Components: shadcn/ui (Radix UI)
- Animations: Framer Motion 12.23.12
- Routing: React Router DOM 6.30.1
- State Management: React Query (TanStack Query)
- Form Handling: React Hook Form 7.61.1
- AI Integration: Google Generative AI
- Build Tool: Vite 5.4.19
- Node.js (v18 or higher)
- npm or yarn
- Clone the repository
git clone https://github.com/Asadp3406/Vit-connect.git
cd Vit-connect- Navigate to project directory
cd "PBL SEPM"- Install dependencies
npm install- Set up environment variables
# Copy the example env file
cp .env.example .env- Add your Google Generative AI API key
Edit
.envfile:
VITE_GOOGLE_API_KEY=your_api_key_here- Start development server
npm run devThe application will be available at http://localhost:5173
npm run dev # Start development server
npm run build # Build for production
npm run build:dev # Build in development mode
npm run preview # Preview production build
npm run lint # Run ESLintPBL SEPM/
βββ src/
β βββ components/ # Reusable UI components
β β βββ ui/ # shadcn/ui components
β β βββ auth/ # Authentication components
β βββ pages/ # Page components
β β βββ Index.tsx # Landing page
β β βββ SocialFeed.tsx
β β βββ NoteShare.tsx
β β βββ Notifications.tsx
β β βββ LostFound.tsx
β β βββ Clubs.tsx
β β βββ Profile.tsx
β βββ contexts/ # React contexts
β βββ hooks/ # Custom React hooks
β βββ lib/ # Utility functions
β βββ services/ # API services
β βββ App.tsx # Main app component
βββ public/ # Static assets
βββ package.json
- Supports image upload in Social Feed and Lost & Found
- Client-side image preview
- Base64 encoding for storage
- Remove/replace functionality
- Secure user authentication
- Protected routes
- User session management
- Profile customization
- Mobile-first approach
- Adaptive layouts for all screen sizes
- Touch-friendly interface
- Optimized for tablets and desktops
- Smooth page transitions
- Interactive hover effects
- Loading states
- Micro-interactions with Framer Motion
- Push your code to GitHub
- Import project in Vercel
- Add environment variables
- Deploy
- Connect GitHub repository
- Configure build settings:
- Build command:
npm run build - Publish directory:
dist
- Build command:
- Add environment variables
- Deploy
| Variable | Description | Required |
|---|---|---|
VITE_GOOGLE_API_KEY |
Google Generative AI API Key | Yes |
Note: Never commit .env file to version control. It's already in .gitignore.
Contributions are welcome! Please feel free to submit a Pull Request.
This project is open source and available under the MIT License.
Asad Pathan
- GitHub: @Asadp3406
- Vishwakarma Institute of Technology, Pune
- Google Generative AI
- shadcn/ui for beautiful components
- The React and TypeScript communities
Made with β€οΈ for VIT Pune students