Skip to content

Asadp3406/Vit-connect

Repository files navigation

VIT Connect πŸŽ“

A comprehensive college management platform for Vishwakarma Institute of Technology (VIT Pune) that connects students, facilitates communication, and streamlines campus life.

VIT Connect React TypeScript Tailwind CSS

✨ Features

πŸ€– AI-Powered Chatbot

  • Intelligent assistant powered by Google Generative AI
  • Instant answers about admissions, programs, fees, and campus facilities
  • Context-aware responses for better user experience

πŸ‘₯ Social Network

  • Connect with fellow students
  • Share posts with photo upload support
  • Like, comment, and engage with the community
  • Real-time feed updates

πŸ“š Note Sharing Platform

  • Upload and share study materials
  • Organize notes by subject and semester
  • Download resources shared by peers
  • Collaborative learning environment

πŸ”” Notifications Hub

  • Training & placement updates
  • Club events and activities
  • Important announcements
  • Deadline reminders

πŸ” Lost & Found

  • Report lost items with photo upload
  • Browse found items
  • Filter by category (Electronics, Documents, Personal Items, etc.)
  • Contact information for item recovery

🎭 College Clubs

  • 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

πŸ‘€ User Profiles

  • Personalized student profiles
  • Department and batch information
  • Activity tracking
  • Secure authentication

πŸš€ Tech Stack

  • 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

πŸ“¦ Installation

Prerequisites

  • Node.js (v18 or higher)
  • npm or yarn

Setup

  1. Clone the repository
git clone https://github.com/Asadp3406/Vit-connect.git
cd Vit-connect
  1. Navigate to project directory
cd "PBL SEPM"
  1. Install dependencies
npm install
  1. Set up environment variables
# Copy the example env file
cp .env.example .env
  1. Add your Google Generative AI API key Edit .env file:
VITE_GOOGLE_API_KEY=your_api_key_here
  1. Start development server
npm run dev

The application will be available at http://localhost:5173

πŸ› οΈ Available Scripts

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 ESLint

πŸ“ Project Structure

PBL 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

🎨 Key Features Implementation

Photo Upload

  • Supports image upload in Social Feed and Lost & Found
  • Client-side image preview
  • Base64 encoding for storage
  • Remove/replace functionality

Authentication

  • Secure user authentication
  • Protected routes
  • User session management
  • Profile customization

Responsive Design

  • Mobile-first approach
  • Adaptive layouts for all screen sizes
  • Touch-friendly interface
  • Optimized for tablets and desktops

Animations

  • Smooth page transitions
  • Interactive hover effects
  • Loading states
  • Micro-interactions with Framer Motion

🌐 Deployment

Vercel (Recommended)

  1. Push your code to GitHub
  2. Import project in Vercel
  3. Add environment variables
  4. Deploy

Netlify

  1. Connect GitHub repository
  2. Configure build settings:
    • Build command: npm run build
    • Publish directory: dist
  3. Add environment variables
  4. Deploy

πŸ” Environment Variables

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.

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

πŸ“„ License

This project is open source and available under the MIT License.

πŸ‘¨β€πŸ’» Developer

Asad Pathan

πŸ™ Acknowledgments

  • Vishwakarma Institute of Technology, Pune
  • Google Generative AI
  • shadcn/ui for beautiful components
  • The React and TypeScript communities

Made with ❀️ for VIT Pune students

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages