📚 Vidya Setu

---

🌟 Vision Statement

Vidya Setu is a centralized student project management platform that bridges the gap between students, faculty, and administrators. It ensures streamlined project submission, monitoring, and evaluation within a single system.

The platform serves both as an academic submission system (institutional style) and a developer-friendly repository (open-source style) to encourage transparency, scalability, and collaboration.

---

✨ Features

🎯 Core Functionality Centralized Project Repository - Store and manage all student projects in one organized location Role-Based Access Control - Distinct interfaces for Students, Faculty, and Administrators Team Collaboration Tools - Multi-user project management with milestone tracking Advanced Search & Filtering - Find projects by title, student, department, or technology stack Version Control Integration - Seamless GitHub/GitLab repository linking

👥 User Roles Students: Upload projects, track progress, collaborate with teams Faculty/Mentors: Evaluate submissions, provide feedback, monitor milestones Administrators: Manage users, departments, and oversee project lifecycle

🔒 Security & Authentication JWT-based secure authentication Password encryption with bcrypt Role-based permission system File upload validation and security

---

🛠️ Tech Stack

Frontend

React with Vite for fast development
TailwindCSS + Shadcn UI for modern styling
Axios for API communication

Backend

Node.js + Express.js server
MongoDB + Mongoose ODM
JWT authentication
Multer + GridFS for file handling

DevOps & Deployment

GitHub Actions for CI/CD
Docker for containerization
MongoDB Atlas cloud database
Nginx for production deployment

---

📂 Project Structure

📁 Vidya_Setu/
├── 📁 backend/
│   ├── 📁 config/          # Database & environment configuration
│   ├── 📁 models/          # MongoDB schemas and data models
│   ├── 📁 routes/          # Express API endpoints
│   ├── 📄 gridfs.js        # GridFS file storage setup
│   ├── 📄 seedData.js      # Sample data seeding
│   ├── 📄 server.js        # Backend application entry point
│   ├── 📄 upload.js        # File upload middleware
│   └── 🔒 .env             # Environment variables
│
├── 📁 src/
│   ├── 📁 assets/          # Static resources (images, icons)
│   ├── 📁 components/      # Reusable React components
│   ├── 📁 data/            # Static and mock data
│   ├── 📁 styles/          # CSS and Tailwind configurations
│   ├── 📄 AdminDashboard.jsx
│   ├── 📄 AdminLogin.jsx
│   ├── 📄 AdminPage.jsx
│   ├── 📄 App.jsx          # Main React application
│   ├── 📄 FacultyApprovalPage.jsx
│   ├── 📄 FacultyDashboard.jsx
│   ├── 📄 FacultyLogin.jsx
│   ├── 📄 FacultyPage.jsx
│   ├── 📄 FacultyProfile.jsx
│   ├── 📄 FacultySettings.jsx
│   ├── 📄 HomePage.jsx
│   ├── 📄 main.jsx         # React application entry point
│   ├── 📄 StudentLogin.jsx
│   ├── 📄 StudentPage.jsx
│   └── 📄 StudentProfile.jsx
│
├── 📄 .gitignore
├── 📄 index.html
├── 📄 package-lock.json
├── 📄 package.json
├── 📄 README.md
└── 📄 vite.config.js

---

⚙️ Installation & Setup

Prerequisites

• Node.js (version 18 or higher)
• MongoDB (local installation or Atlas account)
• Git for version control

🚀 Quick Start

🔽 Click to expand installation steps

1. Clone the Repository

   git clone https://github.com/your-username/Vidya_Setu.git
   cd Vidya_Setu

2. Backend Setup

   cd backend
   npm install

3. Environment Configuration

   Create a .env file in the backend/ directory:

   MONGODB_URI=mongodb://localhost:27017/vidya_setu
   JWT_SECRET=your-super-secret-jwt-key
   PORT=5000
   NODE_ENV=development

4. Start Backend Server

   npm start
   # Server will run on http://localhost:5000

5. Frontend Setup (in a new terminal)

   cd src
   npm install
   npm run dev
   # Frontend will run on http://localhost:5173

6. Access the Application

   Open your browser and navigate to: http://localhost:5173

---

🚀 Deployment Options [PROJECT NOT DEPLOYED YET]

Frontend Deployment Vercel (Recommended for React apps) Netlify (Static site hosting) GitHub Pages (For static builds)

Backend Deployment Render (Full-stack applications) Heroku (Platform as a Service) Railway (Modern deployment platform) Docker + VPS (Self-hosted option)

Database MongoDB Atlas (Recommended cloud solution) MongoDB Community (Self-hosted)

---

🤝 Contributing

We welcome contributions from the community! Here's how you can help:

gitGraph
    commit id: "Fork Repo"
    branch feature
    checkout feature
    commit id: "Add Feature"
    commit id: "Write Tests"
    commit id: "Update Docs"
    checkout main
    merge feature
    commit id: "Deploy 🚀"

Loading

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Development Guidelines

• Follow existing code style and conventions
• Write clear, descriptive commit messages
• Include tests for new features
• Update documentation as needed

---

👨‍💻 Contributors

Lakshita Sethia
Frontend Developer

Jash Thakkar Backend Developer

Hetansh Waghela ML Developer

Darshan Ved Frontend Developer

Vraj Ved Frontend Developer

Nikhil Pise ML Developer

---

📞 Contact & Support

• Project Repository: https://github.com/JashT14/Vidya_Setu
• Issue Tracker: GitHub Issues
• Discussions: GitHub Discussions

---

⭐ Show Your Support

If you find this project helpful, please consider:

• ⭐ Starring the repository
• 🍴 Forking for your own projects
• 🐛 Reporting bugs and issues
• 💡 Suggesting new features

---

📜 License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

---

Made with ❤️ by the GitGoneWild Team